Bug 1899884 - Review Request: mptcpd - multipath TCP daemon
Summary: Review Request: mptcpd - multipath TCP daemon
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Andy Mender
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-11-20 10:09 UTC by Davide Caratti
Modified: 2022-12-10 16:53 UTC (History)
8 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-12-10 16:53:58 UTC
Type: ---
Embargoed:
andymenderunix: fedora-review+


Attachments (Terms of Use)

Description Davide Caratti 2020-11-20 10:09:54 UTC
Spec URL: https://gitlab.com/dcaratti/mptcpd/-/blob/main/mptcpd.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/dcaratti/mptcpd/fedora-rawhide-x86_64/01708160-mptcpd/mptcpd-0.5-1.fc34.src.rpm
Description: The Multipath TCP Daemon - mptcpd - is a daemon for Linux based operating systems that performs multipath TCP path management related operations in the user space. It interacts with the Linux kernel through a generic netlink connection to track per-connection information (e.g. available remote addresses), available network interfaces, request new MPTCP subflows, handle requests for subflows, etc.
Fedora Account System Username: dcaratti

Comment 1 Andy Mender 2020-11-22 18:58:04 UTC
Koji build: https://koji.fedoraproject.org/koji/taskinfo?taskID=56073379

> Release: 1%{?dist}
> License: GPL

Upstream mentions the package is BSD-licensed: https://github.com/intel/mptcpd/blob/master/COPYING
However, that's a different upstream than the one linked on the page from the URL: https://multipath-tcp.org/
Sources: https://github.com/multipath-tcp/mptcp/blob/mptcp_v0.95/COPYING

licensecheck reports GPL, LGPL and BSD:
*No copyright* GNU General Public License (v2.0)
------------------------------------------------
mptcpd-0.5/LICENSES/README

BSD 3-clause "New" or "Revised" License
---------------------------------------
mptcpd-0.5/COPYING

GNU Lesser General Public License
---------------------------------
mptcpd-0.5/LICENSES/COPYING.GPL

The versions don't match either. The original project (?) features 0.95: http://multipath-tcp.org/pmwiki.php?n=Main.Release95
The Intel project features 0.5: https://github.com/intel/mptcpd/releases/tag/v0.5

Could it be that the Source0 field is wrong?

> BuildRequires: libtool
> BuildRequires: automake
> BuildRequires: autoconf
> BuildRequires: autoconf-archive
> BuildRequires: libell-devel
> BuildRequires: systemd-units

Missing BuildRequires on gcc and/or gcc-c++ or clang

> Source0: https://github.com/intel/mptcpd/archive/v%{version}.tar.gz#/%{name}-%{version}.tar.gz

It's possible to get a fully named tarball via a slightly different URL:
> https://github.com/intel/mptcpd/archive/v0.5/mptcpd-0.5.tar.gz

That way you don't have to alias :). However, see earlier comment about sources.

> %install
> install -d %{buildroot}/%{_libexecdir}
> install -d %{buildroot}/%{_mandir}/man8
> install -d %{buildroot}/%{_sysconfdir}/%{name}
> make DESTDIR=%{buildroot} install

Double check, but I think above is the default behavior of the %make_install macro so it can be used instead.

> find %{buildroot} -name '*.la' -exec rm -f {} ';'
> %ldconfig_scriptlets

%ldconfig_scriplets are no longer necessary I believe. However, the hooks for systemd units are missing. Described here: https://docs.fedoraproject.org/en-US/packaging-guidelines/Scriptlets/#_scriptlets

> %package devel
> Summary: MPTCP path manager header files
> Group: Development/Libraries
> Requires: pkgconfig
> License: GPL

The -devel subpackage should typically have a versioned Requires on the main package like so:
Requires: %{name}%{?_isa} = %{version}-%{release}

> %{_libdir}/libmptcpd.*
> %{_libdir}/mptcpd/*.so

Are the SO files in %{_libdir}/mptcpd/ internal to the package? They don't need to be versioned, correct?

> %{_libexecdir}/%{name}
> %{_unitdir}/mptcp.service

The %{_unitdir} macro requires BuildRequires: systemd-rpm-macros

Full review below:
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed


Issues:
=======
- If your application is a C or C++ application you must list a
  BuildRequires against gcc, gcc-c++ or clang.
  Note: No gcc, gcc-c++ or clang found in BuildRequires
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/C_and_C++/
- Development (unversioned) .so files in -devel subpackage, if present.
  Note: Unversioned so-files directly in %_libdir.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/#_devel_packages
- systemd_post is invoked in %post, systemd_preun in %preun, and
  systemd_postun in %postun for Systemd service files.
  Note: Systemd service file(s) in mptcpd
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Scriptlets/#_scriptlets


===== MUST items =====

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: Header files in -devel subpackage, if present.
[x]: ldconfig not called in %post and %postun for Fedora 28 and later.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-clause "New" or "Revised"
     License", "GNU Lesser General Public License", "*No copyright* GNU
     General Public License (v2.0)". 78 files have unknown license.
     Detailed output of licensecheck in
     /data/rpmbuild/SPECS/mptcpd/mptcpd/licensecheck.txt
[!]: License file installed when any subpackage combination is installed.
     Review: No yet. See earlier comments about the -devel subpackage Requires.
[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/lib64/mptcpd, /usr/include/mptcpd
     Review: Own these directories.
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/systemd,
     /usr/lib64/mptcpd, /usr/include/mptcpd, /usr/lib/systemd/system
[x]: %build honors applicable compiler flags or justifies otherwise.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[x]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[x]: Package contains systemd file(s) if in need.
[x]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 1 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: %config files are marked noreplace or the reason is justified.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: No %config files under /usr.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[x]: Reviewer should test that the package builds in mock.
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[!]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in mptcpd-
     devel
[?]: Package functions as described.
[!]: Latest version is packaged.
     Review: Original sources are unclear.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.
[!]: Packages should try to preserve timestamps of original installed
     files.
     Review: "bare" (non-macro) "make install" calls require the "-p" flag.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: The placement of pkgconfig(.pc) files are correct.
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on debuginfo package(s).
     Note: There are rpmlint messages (see attachment).
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Package should not use obsolete m4 macros


Rpmlint
-------
Checking: mptcpd-0.5-1.fc34.x86_64.rpm
          mptcpd-devel-0.5-1.fc34.x86_64.rpm
          mptcpd-debuginfo-0.5-1.fc34.x86_64.rpm
          mptcpd-debugsource-0.5-1.fc34.x86_64.rpm
          mptcpd-0.5-1.fc34.src.rpm
mptcpd.x86_64: E: explicit-lib-dependency libell
mptcpd.x86_64: W: spelling-error Summary(en_US) Multipath -> Multiparty
mptcpd.x86_64: W: spelling-error %description -l en_US multipath -> multiparty
mptcpd.x86_64: W: spelling-error %description -l en_US netlink -> net link, net-link, linnet
mptcpd.x86_64: W: spelling-error %description -l en_US subflows -> sub flows, sub-flows, sunflowers
mptcpd.x86_64: W: incoherent-version-in-changelog 0:0.5-1 ['1:0.5-1.fc34', '1:0.5-1']
mptcpd.x86_64: W: invalid-license GPL
mptcpd.x86_64: W: devel-file-in-non-devel-package /usr/lib64/libmptcpd.so
mptcpd-devel.x86_64: W: no-dependency-on mptcpd/mptcpd-libs/libmptcpd
mptcpd-devel.x86_64: W: invalid-license GPL
mptcpd-debuginfo.x86_64: W: invalid-license GPL
mptcpd-debugsource.x86_64: W: invalid-license GPL
mptcpd.src: W: spelling-error Summary(en_US) Multipath -> Multiparty
mptcpd.src: W: spelling-error %description -l en_US multipath -> multiparty
mptcpd.src: W: spelling-error %description -l en_US netlink -> net link, net-link, linnet
mptcpd.src: W: spelling-error %description -l en_US subflows -> sub flows, sub-flows, sunflowers
mptcpd.src: W: invalid-license GPL
mptcpd.src:58: W: macro-in-comment %doc
5 packages and 0 specfiles checked; 1 errors, 17 warnings.




Rpmlint (debuginfo)
-------------------
Checking: mptcpd-debuginfo-0.5-1.fc34.x86_64.rpm
mptcpd-debuginfo.x86_64: W: invalid-license GPL
1 packages and 0 specfiles checked; 0 errors, 1 warnings.





Rpmlint (installed packages)
----------------------------
(none): E: no installed packages by name mptcpd-devel
(none): E: no installed packages by name mptcpd
(none): E: no installed packages by name mptcpd-debugsource
(none): E: no installed packages by name mptcpd-debuginfo
0 packages and 0 specfiles checked; 0 errors, 0 warnings.



Unversioned so-files
--------------------
mptcpd: /usr/lib64/libmptcpd.so
mptcpd: /usr/lib64/mptcpd/sspi.so

Source checksums
----------------
https://github.com/intel/mptcpd/archive/v0.5.tar.gz#/mptcpd-0.5.tar.gz :
  CHECKSUM(SHA256) this package     : e939470f41d5f8e3d862f736c2b6a618f8ee8ba1415bd80ab85d160f606c70ce
  CHECKSUM(SHA256) upstream package : e939470f41d5f8e3d862f736c2b6a618f8ee8ba1415bd80ab85d160f606c70ce


Requires
--------
mptcpd (rpmlib, GLIBC filtered):
    config(mptcpd)
    libc.so.6()(64bit)
    libdl.so.2()(64bit)
    libell
    libell.so.0()(64bit)
    libell.so.0(ELL_0.10)(64bit)
    libmptcpd.so.0()(64bit)
    rtld(GNU_HASH)

mptcpd-devel (rpmlib, GLIBC filtered):
    /usr/bin/pkg-config
    libmptcpd.so.0()(64bit)
    pkgconfig
    pkgconfig(ell)

mptcpd-debuginfo (rpmlib, GLIBC filtered):

mptcpd-debugsource (rpmlib, GLIBC filtered):



Provides
--------
mptcpd:
    config(mptcpd)
    libmptcpd.so.0()(64bit)
    mptcpd
    mptcpd(x86-64)

mptcpd-devel:
    mptcpd-devel
    mptcpd-devel(x86-64)
    pkgconfig(mptcpd)

mptcpd-debuginfo:
    debuginfo(build-id)
    mptcpd-debuginfo
    mptcpd-debuginfo(x86-64)

mptcpd-debugsource:
    mptcpd-debugsource
    mptcpd-debugsource(x86-64)

Comment 2 Davide Caratti 2020-12-03 10:37:43 UTC
hello Andy, thanks for reviewing.

(In reply to Andy Mender from comment #1)
> Koji build: https://koji.fedoraproject.org/koji/taskinfo?taskID=56073379
> 
> > Release: 1%{?dist}
> > License: GPL
> 
> Upstream mentions the package is BSD-licensed:
> https://github.com/intel/mptcpd/blob/master/COPYING
> However, that's a different upstream than the one linked on the page from
> the URL: https://multipath-tcp.org/
> Sources: https://github.com/multipath-tcp/mptcp/blob/mptcp_v0.95/COPYING
> licensecheck reports GPL, LGPL and BSD:
> *No copyright* GNU General Public License (v2.0)
> ------------------------------------------------
> mptcpd-0.5/LICENSES/README
> 
> BSD 3-clause "New" or "Revised" License
> ---------------------------------------
> mptcpd-0.5/COPYING
> 
> GNU Lesser General Public License
> ---------------------------------
> mptcpd-0.5/LICENSES/COPYING.GPL
> 
> The versions don't match either. The original project (?) features 0.95:
> http://multipath-tcp.org/pmwiki.php?n=Main.Release95
> The Intel project features 0.5:
> https://github.com/intel/mptcpd/releases/tag/v0.5
> 
> Could it be that the Source0 field is wrong?

please note, 'mptcp_v0.95' is *not* the same project ("mptcp" != "mptcpd")
looking at the sources, I see that it's all

SPDX-License-Identifier: BSD-3-Clause

BSD 3-clause

except kernel uAPI headers, that are 

GPL-2.0 WITH Linux-syscall-note

 
> > BuildRequires: libtool
> > BuildRequires: automake
> > BuildRequires: autoconf
> > BuildRequires: autoconf-archive
> > BuildRequires: libell-devel
> > BuildRequires: systemd-units
> 
> Missing BuildRequires on gcc and/or gcc-c++ or clang

ok, will add

> > Source0: https://github.com/intel/mptcpd/archive/v%{version}.tar.gz#/%{name}-%{version}.tar.gz
> 
> It's possible to get a fully named tarball via a slightly different URL:
> > https://github.com/intel/mptcpd/archive/v0.5/mptcpd-0.5.tar.gz
> 
> That way you don't have to alias :). However, see earlier comment about
> sources.

ok, thanks! will try without alias
> 
> > %install
> > install -d %{buildroot}/%{_libexecdir}
> > install -d %{buildroot}/%{_mandir}/man8
> > install -d %{buildroot}/%{_sysconfdir}/%{name}
> > make DESTDIR=%{buildroot} install
> 
> Double check, but I think above is the default behavior of the %make_install
> macro so it can be used instead.

looking at https://github.com/rpm-software-management/rpm/blob/master/macros.in#L1067 , I think you are right. I'll check if build is still ok with %make_install, and eventually replace.

> > find %{buildroot} -name '*.la' -exec rm -f {} ';'
> > %ldconfig_scriptlets
> 
> %ldconfig_scriplets are no longer necessary I believe. However, the hooks
> for systemd units are missing. Described here:
> https://docs.fedoraproject.org/en-US/packaging-guidelines/Scriptlets/
> #_scriptlets

ok, I will check this.

> > %package devel
> > Summary: MPTCP path manager header files
> > Group: Development/Libraries
> > Requires: pkgconfig
> > License: GPL
> 
> The -devel subpackage should typically have a versioned Requires on the main
> package like so:
> Requires: %{name}%{?_isa} = %{version}-%{release}

ok, I will add them.

> > %{_libdir}/libmptcpd.*
> > %{_libdir}/mptcpd/*.so
> 
> Are the SO files in %{_libdir}/mptcpd/ internal to the package? They don't
> need to be versioned, correct?

correct, we don't expect to add a library (at least, not for the moment).

> > %{_libexecdir}/%{name}
> > %{_unitdir}/mptcp.service
> 
> The %{_unitdir} macro requires BuildRequires: systemd-rpm-macros

ok, I will update BuildRequires

thanks!
-- 
davide

Comment 3 Davide Caratti 2020-12-14 13:49:05 UTC
hello Andy, and thanks for detailed info you provided with comment #1.

I updated specfile [1] and srpm [2] to address all MUST and SHOULD items in the checklist. Few additional notes:

- like mentioned in comment #2, 'URL' targets the Multipath TCP "main" project page that includes sub-projects (and mptcpd is one of those), while 'Source0'  targets the official mptcpd github repository. I hope this clarifies your concern about version / Source0.
- I changed the version to 0.5.1, it includes a fix for build failures caused by a recent change in libell-devel [3]. This fix will be also present in the upcoming 0.6 release.

Now rpmlint does not show any warning/error anymore (except false positives due to usage of words like "Multipath", "subflow", "netlink" in the package description).

thanks!
-- 
davide

[1] https://gitlab.com/dcaratti/mptcpd/-/blob/main/mptcpd.spec
[2] https://download.copr.fedorainfracloud.org/results/dcaratti/mptcpd/fedora-rawhide-x86_64/01830906-mptcpd/mptcpd-0.5.1-1.fc34.src.rpm
[3] https://github.com/intel/mptcpd/issues/84

Comment 4 Andy Mender 2020-12-14 19:22:34 UTC
> - like mentioned in comment #2, 'URL' targets the Multipath TCP "main" project page that includes sub-projects (and mptcpd is one of those), while 'Source0'  targets the official mptcpd github repository. I hope this clarifies your concern about version / Source0.

Yes, it does. Thank you for the clarification :).

Everything looks fine now so I'm approving the request. Good job!

Out of curiosity, though, is the Epoch necessary? Usually people try to avoid it, since it complicates versioning and once you add it, you have to keep it.

Comment 5 Davide Caratti 2020-12-22 16:53:41 UTC
(In reply to Andy Mender from comment #4)

> Everything looks fine now so I'm approving the request. Good job!

thanks for reviewing!

> Out of curiosity, though, is the Epoch necessary? Usually people try to
> avoid it, since it complicates versioning and once you add it, you have to
> keep it.

I didn't really realize what the Epoch was (just copied it from a template), until I noticed that the NVR in the Changelog triggered a warning (that I fixed putting '1:' before the NVR).

No, we don't need to define Epoch and I will remove it from the initial specfile if you agree. However, I'm afraid that we might introduce it in the future, in case we find out that the current uAPI can't be used seamlessly by in-tree and out-of-tree kernel implementations: an advance in "Epoch" would mean that we drop support for the OOT uAPI.

(I'm also setting 'block' for FE-NEEDSPONSOR, I might need a sponsorship to perform the initial push for rawhide)

thanks!
--
davide

Comment 6 Gwyn Ciesla 2021-01-19 14:21:32 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/mptcpd

Comment 7 Andy Mender 2021-09-05 17:54:15 UTC
I see the package has been already uploaded to the repository.

Is there anything blocking this request still?

Comment 8 Davide Caratti 2021-09-13 13:42:16 UTC
(In reply to Andy Mender from comment #7)
> I see the package has been already uploaded to the repository.
> 
> Is there anything blocking this request still?

hi Andy, I think we can close this BZ.
thanks,
-- 
davide

Comment 9 Package Review 2022-12-10 16:53:58 UTC
Package is now in repositories, closing review.


Note You need to log in before you can comment on or make changes to this bug.