fpm 1.10.2 → 1.15.0

data/lib/fpm/package/pacman.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 require "fpm/package"
 require "fpm/util"
-require "backports"
+require "backports/latest"
 require "fileutils"
 require "find"
 
@@ -18,10 +18,10 @@ class FPM::Package::Pacman < FPM::Package
   option "--group", "GROUP", "The group owner of files in this package", :default => 'root'
 
   # The list of supported compression types. Default is xz (LZMA2)
-  COMPRESSION_TYPES = [ "gz", "bzip2", "xz", "none" ]
+  COMPRESSION_TYPES = [ "gz", "bzip2", "xz", "zstd", "none" ]
 
   option "--compression", "COMPRESSION", "The compression type to use, must " \
-    "be one of #{COMPRESSION_TYPES.join(", ")}.", :default => "xz" do |value|
+    "be one of #{COMPRESSION_TYPES.join(", ")}.", :default => "zstd" do |value|
     if !COMPRESSION_TYPES.include?(value)
       raise ArgumentError, "Pacman compression value of '#{value}' is invalid. " \
         "Must be one of #{COMPRESSION_TYPES.join(", ")}"
@@ -209,31 +209,39 @@ class FPM::Package::Pacman < FPM::Package
 
   def compression_option
     case self.attributes[:pacman_compression]
-      when nil, "xz"
-        return "--xz"
+      when nil, "zstd"
+        return "--zstd"
       when "none"
         return ""
       when "gz"
         return "-z"
+      when "xz"
+        return "--xz"
       when "bzip2"
         return "-j"
+      when "zstd"
+        return "--zstd"
       else
-        return "--xz"
+        return "--zstd"
       end
   end
 
   def compression_ending
     case self.attributes[:pacman_compression]
-      when nil, "xz"
-        return ".xz"
+      when nil, "zstd"
+        return ".zst"
       when "none"
         return ""
       when "gz"
         return ".gz"
+      when "xz"
+        return ".xz"
       when "bzip2"
         return ".bz2"
+      when "zstd"
+        return ".zst"
       else
-        return ".xz"
+        return ".zst"
       end
   end
 
@@ -245,7 +253,11 @@ class FPM::Package::Pacman < FPM::Package
     Find.find(staging_path) do |path|
       src = path.gsub(/^#{staging_path}/, '')
       dst = build_path(src)
-      copy_entry(path, dst, preserve=true, remove_destination=true)
+      begin
+        copy_entry(path, dst, preserve=true, remove_destination=true)
+      rescue
+        copy_entry(path, dst, preserve=false, remove_destination=true)
+      end
       copy_metadata(path, dst)
     end
 

data/lib/fpm/package/pleaserun.rb

@@ -18,6 +18,7 @@ class FPM::Package::PleaseRun < FPM::Package
 
   option "--name", "SERVICE_NAME", "The name of the service you are creating"
   option "--chdir", "CHDIR", "The working directory used by the service"
+  option "--user", "USER", "The user to use for executing this program."
 
   private
   def input(command)

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

@@ -90,6 +90,11 @@ class get_metadata(Command):
                 for dep in pkg_resources.parse_requirements(
                         self.distribution.install_requires):
                     final_deps.extend(self.process_dep(dep))
+            if getattr(self.distribution, 'extras_require', None):
+                for dep in pkg_resources.parse_requirements(
+                        v for k, v in self.distribution.extras_require.items()
+                        if k.startswith(':') and pkg_resources.evaluate_marker(k[1:])):
+                    final_deps.extend(self.process_dep(dep))
 
         data["dependencies"] = final_deps
 

data/lib/fpm/package/python.rb

@@ -29,6 +29,9 @@ class FPM::Package::Python < FPM::Package
   option "--pypi", "PYPI_URL",
     "PyPi Server uri for retrieving packages.",
     :default => "https://pypi.python.org/simple"
+  option "--trusted-host", "PYPI_TRUSTED",
+    "Mark this host or host:port pair as trusted for pip",
+    :default => nil
   option "--package-prefix", "NAMEPREFIX",
     "(DEPRECATED, use --package-name-prefix) Name to prefix the package " \
     "name with." do |value|
@@ -76,7 +79,11 @@ class FPM::Package::Python < FPM::Package
   option "--setup-py-arguments", "setup_py_argument",
     "Arbitrary argument(s) to be passed to setup.py",
     :multivalued => true, :attribute_name => :python_setup_py_arguments,
-    :default => []
+    :default => [] 
+  option "--internal-pip", :flag,
+    "Use the pip module within python to install modules - aka 'python -m pip'. This is the recommended usage since Python 3.4 (2014) instead of invoking the 'pip' script",
+    :attribute_name => :python_internal_pip,
+    :default => true
 
   private
 
@@ -127,16 +134,56 @@ class FPM::Package::Python < FPM::Package
     target = build_path(package)
     FileUtils.mkdir(target) unless File.directory?(target)
 
-    if attributes[:python_pip].nil?
+    if attributes[:python_internal_pip?]
+      # XXX: Should we detect if internal pip is available?
+      attributes[:python_pip] = [ attributes[:python_bin], "-m", "pip"]
+    end
+
+    # attributes[:python_pip] -- expected to be a path
+    if attributes[:python_pip]
+      logger.debug("using pip", :pip => attributes[:python_pip])
+      # TODO: Support older versions of pip
+
+      pip = [attributes[:python_pip]] if pip.is_a?(String)
+      setup_cmd = [
+        *attributes[:python_pip],
+        "download",
+        "--no-clean",
+        "--no-deps",
+        "--no-binary", ":all:",
+        "-d", build_path,
+        "-i", attributes[:python_pypi],
+      ]
+
+      if attributes[:python_trusted_host]
+        setup_cmd += [
+          "--trusted-host",
+          attributes[:python_trusted_host],
+        ]
+      end
+
+      setup_cmd << want_pkg
+
+      safesystem(*setup_cmd)
+
+      # Pip removed the --build flag sometime in 2021, it seems: https://github.com/pypa/pip/issues/8333
+      # A workaround for pip removing the `--build` flag. Previously, `pip download --build ...` would leave
+      # behind a directory with the Python package extracted and ready to be used.
+      # For example, `pip download ... Django` puts `Django-4.0.4.tar.tz` into the build_path directory.
+      # If we expect `pip` to leave an unknown-named file in the `build_path` directory, let's check for
+      # a single file and unpack it.  I don't know if it will /always/ be a .tar.gz though.
+      files = ::Dir.glob(File.join(build_path, "*.tar.gz"))
+      if files.length != 1
+        raise "Unexpected directory layout after `pip download ...`. This might be an fpm bug? The directory is #{build_path}"
+      end
+
+      safesystem("tar", "-zxf", files[0], "-C", target)
+    else
       # no pip, use 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
-      logger.debug("using pip", :pip => attributes[:python_pip])
-      # TODO: Support older versions of pip
-      safesystem(attributes[:python_pip], "download", "--no-clean", "--no-deps", "--no-binary", ":all:", "-i", attributes[:python_pypi], "--build", target,  want_pkg)
     end
 
     # easy_install will put stuff in @tmpdir/packagename/, so find that:
@@ -183,7 +230,7 @@ class FPM::Package::Python < FPM::Package
 
     output = ::Dir.chdir(setup_dir) do
       tmp = build_path("metadata.json")
-      setup_cmd = "env PYTHONPATH=#{pylib} #{attributes[:python_bin]} " \
+      setup_cmd = "env PYTHONPATH=#{pylib}:$PYTHONPATH #{attributes[:python_bin]} " \
         "setup.py --command-packages=pyfpm get_metadata --output=#{tmp}"
 
       if attributes[:python_obey_requirements_txt?]

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,10 +27,10 @@ class FPM::Package::RPM < FPM::Package
 
   COMPRESSION_MAP = {
     "none" => "w0.gzdio",
-    "xz" => "w9.xzdio",
-    "xzmt" => "w9T.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,
@@ -68,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|
@@ -142,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,16 +192,26 @@ class FPM::Package::RPM < FPM::Package
   # Replace * with [*] to make rpm not use globs
   # Replace ? with [?] to make rpm not use globs
   # Replace % with [%] to make rpm not expand macros
+  # Replace whitespace with ? to make rpm not split the filename
+  # If and only if any of the above are done, then also replace ' with \', " with \", and \ with \\\\
+  #   to accommodate escape and quote processing that rpm will perform in that case (but not otherwise)
   def rpm_fix_name(name)
-    name = name.gsub(/(\ |\[|\]|\*|\?|\%|\$)/, {
-      ' ' => '?',
-      '%' => '[%]',
-      '$' => '[$]',
-      '?' => '[?]',
-      '*' => '[*]',
-      '[' => '[\[]',
-      ']' => '[\]]'
-    })
+    if name.match?(/[ \t*?%$\[\]]/)
+      name = name.gsub(/(\ |\t|\[|\]|\*|\?|\%|\$|'|"|\\)/, {
+        ' '  => '?',
+        "\t" => '?',
+        '%'  => '[%]',
+        '$'  => '[$]',
+        '?'  => '[?]',
+        '*'  => '[*]',
+        '['  => '[\[]',
+        ']'  => '[\]]',
+        '"'  => '\\"',
+        "'"  => "\\'",
+        '\\' => '\\\\\\\\',
+      })
+    end
+    name
   end
 
   def rpm_file_entry(file)
@@ -226,6 +252,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"
@@ -238,6 +266,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
 
@@ -516,10 +550,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)
@@ -597,7 +632,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"

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.
@@ -111,8 +113,7 @@ class FPM::Package::Virtualenv < FPM::Package
     # Why is this hack here? It looks important, so I'll keep it in.
     safesystem(python_exe, pip_exe, "install", "-U", "-i",
                attributes[:virtualenv_pypi],
-               "pip", "distribute")
-    safesystem(python_exe, pip_exe, "uninstall", "-y", "distribute")
+               "pip")
 
     extra_index_url_args = []
     if attributes[:virtualenv_pypi_extra_index_urls]

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"

data/lib/fpm/package.rb

@@ -4,7 +4,7 @@ require "pathname" # stdlib
 require "find"
 require "tmpdir" # stdlib
 require "ostruct"
-require "backports/2.0.0/stdlib/ostruct"
+require "backports/latest"
 require "socket" # stdlib, for Socket.gethostname
 require "shellwords" # stdlib, for Shellwords.escape
 require "erb" # stdlib, for template processing
@@ -316,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) } \
@@ -331,11 +331,12 @@ class FPM::Package
     template_path = File.join(template_dir, path)
     template_code = File.read(template_path)
     logger.info("Reading template", :path => template_path)
-    erb = ERB.new(template_code, nil, "-")
+    erb = erbnew(template_code)
     erb.filename = template_path
     return erb
   end # def template
 
+
   #######################################
   # The following methods are provided to
   # easily override particular substitut-
@@ -518,7 +519,7 @@ class FPM::Package
   # flag), then apply it as an ERB template.
   def script(script_name)
     if attributes[:template_scripts?]
-      erb = ERB.new(scripts[script_name], nil, "-")
+      erb = erbnew(scripts[script_name])
       # TODO(sissel): find the original file name for the file.
       erb.filename = "script(#{script_name})"
       return erb.result(binding)

data/lib/fpm/util/tar_writer.rb

@@ -29,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)