fpm 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51484aca566bb4b8a1362c216c96aeb3fe0400abc44befefe32152624e99148
-  data.tar.gz: 1ae93c91155b91e8decc380fa502ed8e38dd14d74df232bf29ece3c89f34ca4a
+  metadata.gz: '0970e7bbf6bfc2becbfc2c4ed787bb08eb8eef555b6cc969f219685dc67c8056'
+  data.tar.gz: 1472f32b8133588cb6ce39311c1f2e16fbbe86204c65b4ec5fc9ed7181fd6550
 SHA512:
-  metadata.gz: dbca18e4c26ed2d88e9918985288617e8678e5a8d2872170ea5b1a35ac63e740c317513faa5ed9d9c12efef9dc464e09f324e94b2504ceaddf58c02aeecd2ec8
-  data.tar.gz: 0f1865843b14ac86cd4d8fdf0a7b71d1dfd2c5912e9b66dd7e2169a659646afbfc7adc61da55e9ac8414944e717a7b90c7ea5b3d6994301549e5af73b88994b0
+  metadata.gz: 336e859e103edc0c76fa9f89f4dbfc1d9c9a183d7314e405ff8ddafe24134655cfb90c8121566173a4986ad72064b108d89d81e06426e2b3586ec0110d132f9e
+  data.tar.gz: 1e7e9fb8f0eff4dcbf4aa45c526b5295b8534c83d97555d7322e69b6b6a6738494a6fac872aec85a3c94b0b5c86720bef52271d2ae75bb2e8916c4978968ed9f

data/CHANGELOG.rst

@@ -1,11 +1,25 @@
 Release Notes and Change Log
 ============================
 
+1.14.0 (November 9, 2021)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+* python: Use pip by default for fetching Python packages. This matches the Python 3 "installation" docs which recommend calling pip as ``python -m pip`` where ``python`` depends on ``--python-bin`` (default "python"). Previous default was to use `easy_install` which is no longer available on many newer systems. To use easy_install, you can set ``--no-python-internal-pip`` to revert this pip default. Further, you can specify your own pip path instead of using ``python -m pip`` with the ``--python-pip /path/to/pip`` flag. (`#1820`_, `#1821`_; Jordan Sissel)
+* python: Support extras_require build markers in python packages (`#1307`_, `#1816`_; Joris Vandermeersch)
+* freebsd: Fix bug which caused fpm to generate incorrect FreeBSD packages "missing leading `/`" (`#1811`_, `#1812`_, `#1844`_, `#1832`_, `#1845`_; Vlastimil Holer, Clayton Wong, Markus Ueberall, Jordan Sissel)
+* deb: In order to only allow fpm to create valid packages, fpm now rejects packages with invalid "provides" (``--provides``) values. (`#1829`_, `#1825`_; Jordan Sissel, Peter Teichman)
+* deb: Only show a warning about /etc and config files if there are files in /etc (`#1852`_, `#1851`_; Jordan Sissel)
+
+* rpm: replace dash with underscore in rpm's "Release" field aka what fpm calls ``--iteration``. (`#1834`_, `#1833`_; Jordan Sissel)
+* empty: `fpm -s empty ...` now defaults to "all" architecture instead of "native". (`#1850`_, `#1846`_; Jordan Sissel)
+* Significant documentation improvements rewriting most of the documentation. New overview pages, full CLI flag listing, and new sections dedicated package types (rpm, cpan, deb, etc). (`#1815`_, `#1817`_, `#1838`_; Vedant K, Jordan Sissel)
+* Typo fixes in documentation are always appreciated! (`#1842`_; Clayton Wong)
+* fpm can now (we hope!) now be tested more easily from docker (`#1818`_, `#1682`_, `#1453`_; @directionless, Jordan Sissel, Douglas Muth)
+
 1.13.1 (July 6, 2021)
 ^^^^^^^^^^^^^^^^^^^^^
 * deb: The `--provides` flag now allows for versions. Previously, fpm would
   remove the version part of a provides field when generating deb packages.
-  (`#1788`_, `#1803`_; Jordan Sissel, Phil Schwarz, tympanix)
+  (`#1788`_, `#1803`_; Jordan Sissel, Phil Schwartz, tympanix)
 * osxpkg: Update documentation to include installing `rpm` tools on OSX
   (`#1797`_; allen joslin)
 
@@ -20,8 +34,7 @@ Release Notes and Change Log
 * Ruby 3.0 support: Added `rexml` as a runtime dependency. In Ruby 2.0, `rexml` came by default, but in Ruby 3.0, `rexml` is now a bundled gem and some distributiosn do not include it by default. (`#1794`_; Jordan Sissel)
 * Fix error "git: not found (Git::GitExecuteError)". Now loads `git` library only when using git features. (`#1753`_, `#1748`_, `#1751`_, `#1766`_; Jordan Sissel, Cameron Nemo, Jason Rogers, Luke Short)
 * deb: Fix syntax error in `postinst` (`--after-install`) script. (`#1752`_, `#1749`_, `#1764`_; rmanus, Adam Mohammed, Elliot Murphy, kimw, Jordan Sissel)
-* deb: --deb-compression now uses the same compression and file suffix on the control.tar file (`#1760`_; Philippe Poilbarbe
-)
+* deb: --deb-compression now uses the same compression and file suffix on the control.tar file (`#1760`_; Philippe Poilbarbe)
 
 
 1.12.0 (January 19, 2021)
@@ -59,7 +72,7 @@ Release Notes and Change Log
 * cpan: Adds `--[no-]cpan-verbose` flag which, when set, runs `cpanm` with the `--verbose` flag (`#1511`_; William N. Braswell, Jr)
 
 1.10.0 (May 21, 2018)
-^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^
 
 * Pin `ruby-xz` dependency to one which allows Ruby versions older than 2.3.0 (`#1494`_; Marat Sharafutdinov)
 * Documentation improvements: `#1488`_; Arthur Burkart. `#1384`_; Justin Kolberg. `#1452`_; Anatoli Babenia.
@@ -87,7 +100,7 @@ Release Notes and Change Log
 * rpm: Fix `--config-files` handling (`#1390`_, `#1391`_; Jordan Sissel)
 
 1.9.1 (July 28, 2017) happy sysadmin day!
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * Documentation improvements: `#1291`_; Pablo Castellano. `#1321`_; ge-fa. `#1309`_; jesusbagpuss. `#1349`_; Perry Stole. `#1352`_, Jordan Sissel. `#1384`_; Justin Kolberg.
 * Testing improvements: `#1320`_; Rob Young. `#1266`_; Ryan Parman. `#1374`_; Thiago Figueiró.
@@ -116,9 +129,9 @@ Release Notes and Change Log
 * Other: Remove unused archive-tar-minitar as a dependency of fpm (`#1355`_; Diego Martins)
 * Other: Add stud as a runtime dependency (`#1354`_; Elan Ruusamäe)
 
-.. _reproducible_builds:: https://reproducible-builds.org/
-.. _path mapping:: http://fpm.readthedocs.io/en/latest/source/dir.html#path-mapping
-.. _Deterministic output:: http://fpm.readthedocs.io/en/latest/source/gem.html
+.. _reproducible_builds: https://reproducible-builds.org/
+.. _path mapping: source/dir.html#path-mapping
+.. _Deterministic output: source/gem.html
 
 1.9.0 (July 28, 2017)
 ^^^^^^^^^^^^^^^^^^^^^

data/CONTRIBUTORS

@@ -21,6 +21,7 @@ sbuss
 Brett Gailey (github: dnbert)
 Daniel Haskin (github: djhaskin987)
 Richard Grainger (github: liger1978)
+seph (github: directionless)
 
 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

data/lib/fpm/package/deb.rb

@@ -25,6 +25,17 @@ class FPM::Package::Deb < FPM::Package
   # The list of supported compression types. Default is gz (gzip)
   COMPRESSION_TYPES = [ "gz", "bzip2", "xz", "none" ]
 
+  # https://www.debian.org/doc/debian-policy/ch-relationships.html#syntax-of-relationship-fields
+  # Example value with version relationship: libc6 (>= 2.2.1)
+  # Example value: libc6
+
+  # Version string docs here: https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version
+  # The format is: [epoch:]upstream_version[-debian_revision].
+  # epoch - This is a single (generally small) unsigned integer
+  # upstream_version - must contain only alphanumerics 6 and the characters . + - ~
+  # debian_revision - only alphanumerics and the characters + . ~
+  RELATIONSHIP_FIELD_PATTERN = /^(?<name>[A-z0-9_-]+)(?: *\((?<relation>[<>=]+) *(?<version>(?:[0-9]+:)?[0-9A-Za-z+~.-]+(?:-[0-9A-Za-z+~.]+)?)\))?$/
+
   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 " \
@@ -427,6 +438,12 @@ class FPM::Package::Deb < FPM::Package
 
   def output(output_path)
     self.provides = self.provides.collect { |p| fix_provides(p) }
+
+    self.provides.each do |provide|
+      if !valid_provides_field?(provide)
+        raise FPM::InvalidPackageConfiguration, "Found invalid Provides field values (#{provide.inspect}). This is not valid in a Debian package."
+      end
+    end
     output_check(output_path)
     # Abort if the target path already exists.
 
@@ -595,7 +612,7 @@ class FPM::Package::Deb < FPM::Package
         compression = "-z"
       when "bzip2"
         datatar = build_path("data.tar.bz2")
-        controltar = build_path("control.tar.bz2")
+        controltar = build_path("control.tar.gz")
         compression = "-j"
       when "xz"
         datatar = build_path("data.tar.xz")
@@ -660,6 +677,43 @@ class FPM::Package::Deb < FPM::Package
       fix_provides(provides)
     end.flatten
 
+    if origin == FPM::Package::CPAN
+      # The fpm cpan code presents dependencies and provides fields as perl(ModuleName)
+      # so we'll need to convert them to something debian supports.
+
+      # Replace perl(ModuleName) > 1.0 with Debian-style perl-ModuleName (> 1.0)
+      perldepfix = lambda do |dep|
+        m = dep.match(/perl\((?<name>[A-Za-z0-9_:]+)\)\s*(?<op>.*$)/)
+        if m.nil?
+          # 'dep' syntax didn't look like 'perl(Name) > 1.0'
+          dep
+        else
+          # Also replace '::' in the perl module name with '-'
+          modulename = m["name"].gsub("::", "-")
+         
+          # Fix any upper-casing or other naming concerns Debian has about packages
+          name = "#{attributes[:cpan_package_name_prefix]}-#{modulename}"
+
+          if m["op"].empty?
+            name
+          else
+            # 'dep' syntax was like this (version constraint): perl(Module) > 1.0
+            "#{name} (#{m["op"]})"
+          end
+        end
+      end
+
+      rejects = [ "perl(vars)", "perl(warnings)", "perl(strict)", "perl(Config)" ]
+      self.dependencies = self.dependencies.reject do |dep|
+        # Reject non-module Perl dependencies like 'vars' and 'warnings'
+        rejects.include?(dep)
+      end.collect(&perldepfix).collect(&method(:fix_dependency))
+
+      # Also fix the Provides field 'perl(ModuleName) = version' to be 'perl-modulename (= version)'
+      self.provides = self.provides.collect(&perldepfix).collect(&method(:fix_provides))
+
+    end # if origin == FPM::Packagin::CPAN
+
     if origin == FPM::Package::Deb
       changelog_path = staging_path("usr/share/doc/#{name}/changelog.Debian.gz")
       if File.exists?(changelog_path)
@@ -774,6 +828,32 @@ class FPM::Package::Deb < FPM::Package
     end
   end # def fix_dependency
 
+  def valid_provides_field?(text)
+    m = RELATIONSHIP_FIELD_PATTERN.match(text)
+    if m.nil?
+      logger.error("Invalid relationship field for debian package: #{text}")
+      return false
+    end
+
+    # Per Debian Policy manual, https://www.debian.org/doc/debian-policy/ch-relationships.html#syntax-of-relationship-fields
+    # >> The relations allowed are <<, <=, =, >= and >> for strictly earlier, earlier or equal,
+    # >> exactly equal, later or equal and strictly later, respectively. The exception is the
+    # >> Provides field, for which only = is allowed
+    if m["relation"] == "=" || m["relation"] == nil
+      return true
+    end
+    return false
+  end
+
+  def valid_relationship_field?(text)
+    m = RELATIONSHIP_FIELD_PATTERN.match(text)
+    if m.nil?
+      logger.error("Invalid relationship field for debian package: #{text}")
+      return false
+    end
+    return true
+  end
+
   def fix_provides(provides)
     name_re = /^[^ \(]+/
     name = provides[name_re]
@@ -820,12 +900,9 @@ class FPM::Package::Deb < FPM::Package
 
     # Tar up the staging_path into control.tar.{compression type}
     case self.attributes[:deb_compression]
-      when "gz", nil
+      when "gz", "bzip2", nil
         controltar = "control.tar.gz"
         compression = "-z"
-      when "bzip2"
-        controltar = "control.tar.bz2"
-        compression = "-j"
       when "xz"
         controltar = "control.tar.xz"
         compression = "-J"
@@ -930,7 +1007,7 @@ class FPM::Package::Deb < FPM::Package
     etcfiles = []
     # Add everything in /etc
     begin
-      if !attributes[:deb_no_default_config_files?]
+      if !attributes[:deb_no_default_config_files?] && File.exists?(staging_path("/etc"))
         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")

data/lib/fpm/package/empty.rb

@@ -4,6 +4,18 @@ require "backports/latest"
 # Empty Package type. For strict/meta/virtual package creation
 
 class FPM::Package::Empty < FPM::Package
+  def initialize(*args)
+    super(*args)
+
+    # Override FPM::Package's default "native" architecture value
+    # This feels like the right default because an empty package has no
+    # architecture-specific files, and in most cases an empty package should be
+    # installable anywhere.
+    #
+    # https://github.com/jordansissel/fpm/issues/1846
+    @architecture = "all"
+  end
+
   def output(output_path)
     logger.warn("Your package has gone into the void.")
   end

data/lib/fpm/package/freebsd.rb

@@ -86,9 +86,7 @@ class FPM::Package::FreeBSD < FPM::Package
     # We use --files-from here to keep the tar entries from having `./` as the prefix.
     # This is done as a best effor to mimic what FreeBSD packages do, having everything at the top-level as
     # file names, like "+MANIFEST" instead of "./+MANIFEST"
-    # Note: This will include top-level files like "/usr/bin/foo" listed in the tar as "usr/bin/fo" without
-    # a leading slash. I don't know if this has any negative impact on freebsd packages.
-    safesystem("tar", "-Jcf", output_path, "-C", staging_path, "--files-from", build_path("file_list"))
+    safesystem("tar", "-Jcf", output_path, "-C", staging_path, "--files-from", build_path("file_list"), "--transform", 's|^\([^+]\)|/\1|')
   end # def output
 
   # Handle architecture naming conversion:

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

@@ -79,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
 
@@ -130,23 +134,24 @@ class FPM::Package::Python < FPM::Package
     target = build_path(package)
     FileUtils.mkdir(target) unless File.directory?(target)
 
-    if attributes[:python_pip].nil?
-      # 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
+    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],
+        *attributes[:python_pip],
         "download",
         "--no-clean",
         "--no-deps",
-        "--no-binary",
-        ":all:",
+        "--no-binary", ":all:",
+        "-d", build_path,
         "-i", attributes[:python_pypi],
       ]
 
@@ -164,6 +169,12 @@ class FPM::Package::Python < FPM::Package
       ]
       
       safesystem(*setup_cmd)
+    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)
     end
 
     # easy_install will put stuff in @tmpdir/packagename/, so find that:

data/lib/fpm/package/rpm.rb

@@ -254,6 +254,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
 

data/lib/fpm/version.rb

@@ -1,3 +1,3 @@
 module FPM
-  VERSION = "1.13.1"
+  VERSION = "1.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fpm
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -86,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
 - !ruby/object:Gem::Dependency
   name: pleaserun
   requirement: !ruby/object:Gem::Requirement
@@ -294,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: fpm - package building and mangling