Bug 1906851 - Review Request: python-aiocoap - Python CoAP library
Summary: Review Request: python-aiocoap - Python CoAP library
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
unspecified
medium
Target Milestone: ---
Assignee: Nobody's working on this, feel free to take it
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FE-DEADREVIEW IoT 1906624 1907159
TreeView+ depends on / blocked
 
Reported: 2020-12-11 14:40 UTC by Fabian Affolter
Modified: 2021-07-01 00:45 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-07-01 00:45:27 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Fabian Affolter 2020-12-11 14:40:48 UTC
Spec URL: https://fab.fedorapeople.org/packages/SRPMS/python-aiocoap.spec
SRPM URL: https://fab.fedorapeople.org/packages/SRPMS/python-aiocoap-0.4-0.b3.fc33.src.rpm

Project URL: https://github.com/chrysn/aiocoap

Description:
The aiocoap package is an implementation of CoAP, the Constrained Application
Protocol.

Koji scratch build:
https://koji.fedoraproject.org/koji/taskinfo?taskID=57258384

rpmlint output:
$ rpmlint python-aiocoap-0.4-0.b3.fc33.src.rpm 
1 packages and 0 specfiles checked; 0 errors, 0 warnings.

$ rpmlint python3-aiocoap*
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-client
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-fileserver
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-proxy
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-rd
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) aiocoap -> tapioca
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) linkheader -> link header, link-header, headliner
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US linkheader -> link header, link-header, headliner
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US aiocoap -> tapioca
python3-aiocoap+linkheader.noarch: E: description-line-too-long C This is a metapackage bringing in linkheader extras requires for python3-aiocoap.
python3-aiocoap+linkheader.noarch: W: no-documentation
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) aiocoap -> tapioca
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) prettyprint -> pretty print, pretty-print, interpret
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US prettyprint -> pretty print, pretty-print, interpret
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US aiocoap -> tapioca
python3-aiocoap+prettyprint.noarch: E: description-line-too-long C This is a metapackage bringing in prettyprint extras requires for python3-aiocoap.
python3-aiocoap+prettyprint.noarch: W: no-documentation
3 packages and 0 specfiles checked; 2 errors, 18 warnings.

Fedora Account System Username: fab

The rpmlint issues are related to the used macros.

Comment 1 Ben Beasley 2021-01-28 16:47:11 UTC
My comments below are long, but the package is actually very close to being
ready for approval.

Package Review
==============

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


Issues:
=======
- Package installs properly.
  Note: Installation errors (see attachment)
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/

  Error:
   Problem: conflicting requests
    - nothing provides python3.9dist(cbor) needed by python3-aiocoap+prettyprint-0.4-0.b3.fc34.noarch

  Either drop the prettyprint extra metapackage (with a comment explaining it
  is due to the missing dependency), or package https://pypi.org/project/cbor/.
  Upstream is here: https://github.com/brianolson/cbor_py. I will review it,
  if you choose that route and link the review request from this one. 

- There are more extras that should be metapackages, or for which you should
  document why you did not package them:

  oscore needs cbor, just as prettyprint does (other dependencies are
  available)

  tinydtls needs https://pypi.org/project/DTLSSocket/, which bundles
  https://projects.eclipse.org/projects/iot.tinydtls.

  If you do package cbor, then you will be able to build the documentation too.

- If you do end up with more than one usable extra metapackage, note that the
  %python_extras_subpkg macro can do multiple extras in a single call, like:

    %{?python_extras_subpkg:%python_extras_subpkg -n python3-%{pypi_name} -i %{python3_sitelib}/*.egg-info linkheader prettyprint oscore}

- The fedora-review tool says:

  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.
  Note: License file LICENSE.html is not marked as %license
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/LicensingGuidelines/#_license_text

  On manual review, LICENSE.html is generated from LICENSE.rst, which just
  references the top-level LICENSE file:

    LICENSE
    =======
    
    .. include:: ../LICENSE


  I would actually just change

    %license doc/LICENSE.rst LICENSE

  to

    %license LICENSE

  because that trivial reStructuredText file is not contributing anything useful.

- The python_provide macro is obsolete. Please remove it. You may use the
  %py_provides macro instead if you are building for Fedora 32, otherwise just
  drop it entirely.

  https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_the_py_provides_macro

- In %check, you have a comment
    # There are missing dependencies
  to which I would ask, which ones correspond to which things you are skipping?

  To me, it looks like the tests automatically skip based on installed
  dependencies, and the errors if you run pytest without any extra skips are
  just due to buggy test code. Maybe they worked with an old pytest version.

    ==================================== ERRORS ====================================
    _____________________ ERROR at setup of test_is_successful _____________________
    file /builddir/build/BUILD/aiocoap-0.4b3/tests/fixtures.py, line 36
      def test_is_successful(testcase):
    E       fixture 'testcase' not found
    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
    >       use 'pytest --fixtures [testpath]' for help on them.
    
    /builddir/build/BUILD/aiocoap-0.4b3/tests/fixtures.py:36
    ____________________________ ERROR at setup of test ____________________________
    file /builddir/build/BUILD/aiocoap-0.4b3/tests/test_oscore_plugtest.py, line 184
              test = lambda self, x=x: self._test_plugtestclient(x)
    E       fixture 'self' not found
    >       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, monkeypatch, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
    >       use 'pytest --fixtures [testpath]' for help on them.
    
    /builddir/build/BUILD/aiocoap-0.4b3/tests/test_oscore_plugtest.py:184

  I found that the tests run successfully with only
  “--ignore tests/test_oscore_plugtest.py” and
  “-k "not test_registration"” is not needed.

- The tests have a lot of DeprecationWarning messages about the loop parameter;
  this really is removed in Python 3.10, which is coming in Fedora 35. If this
  package is approved, you *will* have an issue automatically filed about this
  at some point, as Fedora is already doing test builds with Python 3.10. See
  https://fedoraproject.org/wiki/Changes/Python3.10 for more information and
  for instructions for testing this yourself. This is not a review blocker,
  just a warning that you will have to be prepared to deal with this even if
  upstream takes a long time to fix it, or your package will be FTBFS in Fedora
  35.

- As always when I review a Python package, I will note that generated BR’s
  from pyproject-rpm-macros are optional, but they do make things easier.

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

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "Expat License". 41 files have unknown
     license. Detailed output of licensecheck in
     /home/reviewer/1906851-python-aiocoap/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[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.
[-]: 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.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 20480 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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]: 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]: 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

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[ ]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

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

Generic:
[-]: 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).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-aiocoap , python3-aiocoap+linkheader ,
     python3-aiocoap+prettyprint
[x]: Package functions as described.
[x]: Latest version is packaged.
[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.
[x]: %check is present and all tests pass.

     See notes in issues regarding skipped tests.

[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[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]: 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:
[!]: Rpmlint is run on all installed packages.
     Note: Mock build failed
     See: https://docs.fedoraproject.org/en-US/packaging-
     guidelines/#_use_rpmlint
[x]: Spec file according to URL is the same as in SRPM.


Installation errors
-------------------
INFO: mock.py version 2.9 starting (python version = 3.9.1, NVR = mock-2.9-1.fc33)...
Start: init plugins
INFO: selinux enabled
Finish: init plugins
INFO: Signal handler active
Start: run
Start: chroot init
INFO: calling preinit hooks
INFO: enabled root cache
INFO: enabled package manager cache
Start: cleaning package manager metadata
Finish: cleaning package manager metadata
INFO: enabled HW Info plugin
Mock Version: 2.9
INFO: Mock Version: 2.9
Finish: chroot init
INFO: installing package(s): /home/reviewer/1906851-python-aiocoap/results/python-aiocoap-doc-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap+prettyprint-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap+linkheader-0.4-0.b3.fc34.noarch.rpm
ERROR: Command failed: 
 # /usr/bin/dnf --installroot /var/lib/mock/fedora-rawhide-x86_64/root/ --releasever 34 --setopt=deltarpm=False --allowerasing --disableplugin=local --disableplugin=spacewalk install /home/reviewer/1906851-python-aiocoap/results/python-aiocoap-doc-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap+prettyprint-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap-0.4-0.b3.fc34.noarch.rpm /home/reviewer/1906851-python-aiocoap/results/python3-aiocoap+linkheader-0.4-0.b3.fc34.noarch.rpm --setopt=tsflags=nocontexts



Rpmlint
-------
Checking: python3-aiocoap-0.4-0.b3.fc34.noarch.rpm
          python-aiocoap-doc-0.4-0.b3.fc34.noarch.rpm
          python3-aiocoap+linkheader-0.4-0.b3.fc34.noarch.rpm
          python3-aiocoap+prettyprint-0.4-0.b3.fc34.noarch.rpm
          python-aiocoap-0.4-0.b3.fc34.src.rpm
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-client
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-fileserver
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-proxy
python3-aiocoap.noarch: W: no-manual-page-for-binary aiocoap-rd
python-aiocoap-doc.noarch: W: summary-not-capitalized C aiocoap documentation
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) aiocoap -> tapioca
python3-aiocoap+linkheader.noarch: W: spelling-error Summary(en_US) linkheader -> link header, link-header, headliner
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US linkheader -> link header, link-header, headliner
python3-aiocoap+linkheader.noarch: W: spelling-error %description -l en_US aiocoap -> tapioca
python3-aiocoap+linkheader.noarch: E: description-line-too-long C This is a metapackage bringing in linkheader extras requires for python3-aiocoap.
python3-aiocoap+linkheader.noarch: W: no-documentation
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) aiocoap -> tapioca
python3-aiocoap+prettyprint.noarch: W: spelling-error Summary(en_US) prettyprint -> pretty print, pretty-print, interpret
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US prettyprint -> pretty print, pretty-print, interpret
python3-aiocoap+prettyprint.noarch: W: spelling-error %description -l en_US aiocoap -> tapioca
python3-aiocoap+prettyprint.noarch: E: description-line-too-long C This is a metapackage bringing in prettyprint extras requires for python3-aiocoap.
python3-aiocoap+prettyprint.noarch: W: no-documentation
5 packages and 0 specfiles checked; 2 errors, 19 warnings.




Source checksums
----------------
https://github.com/chrysn/aiocoap/archive/0.4b3/aiocoap-0.4b3.tar.gz :
  CHECKSUM(SHA256) this package     : 30e648c83b584d10392306494bc2977bcc4adb2254d5b20b46ebeeeb07ed0675
  CHECKSUM(SHA256) upstream package : 30e648c83b584d10392306494bc2977bcc4adb2254d5b20b46ebeeeb07ed0675


Requires
--------
python3-aiocoap (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3.9dist(setuptools)

python-aiocoap-doc (rpmlib, GLIBC filtered):

python3-aiocoap+linkheader (rpmlib, GLIBC filtered):
    python(abi)
    python3-aiocoap
    python3.9dist(linkheader)
    python3.9dist(setuptools)

python3-aiocoap+prettyprint (rpmlib, GLIBC filtered):
    python(abi)
    python3-aiocoap
    python3.9dist(cbor)
    python3.9dist(linkheader)
    python3.9dist(pygments)
    python3.9dist(setuptools)
    python3.9dist(termcolor)



Provides
--------
python3-aiocoap:
    python-aiocoap
    python3-aiocoap
    python3.9-aiocoap
    python3.9dist(aiocoap)
    python3dist(aiocoap)

python-aiocoap-doc:
    python-aiocoap-doc

python3-aiocoap+linkheader:
    python-aiocoap+linkheader
    python3-aiocoap+linkheader
    python3.9-aiocoap+linkheader
    python3.9dist(aiocoap[linkheader])
    python3dist(aiocoap[linkheader])

python3-aiocoap+prettyprint:
    python-aiocoap+prettyprint
    python3-aiocoap+prettyprint
    python3.9-aiocoap+prettyprint
    python3.9dist(aiocoap[prettyprint])
    python3dist(aiocoap[prettyprint])



Generated by fedora-review 0.7.6 (b083f91) last change: 2020-11-10
Command line :/usr/bin/fedora-review -b 1906851
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api, Python
Disabled plugins: Perl, fonts, Haskell, Ocaml, Java, PHP, R, C/C++, SugarActivity
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 2 Zbigniew Jędrzejewski-Szmek 2021-02-20 12:50:12 UTC
It'd be nice to get the expliot FTI fixed…

Comment 3 Package Review 2021-02-28 00:45:44 UTC
This is an automatic action taken by review-stats script.

The ticket submitter failed to clear the NEEDINFO flag in a month.
As per https://fedoraproject.org/wiki/Policy_for_stalled_package_reviews
we consider this ticket as DEADREVIEW and proceed to close it.

Comment 4 Robert-André Mauchin 🐧 2021-05-13 13:55:08 UTC
Do you plan on addressing the points found by Ben Beasley?

Comment 5 Package Review 2021-07-01 00:45:27 UTC
This is an automatic action taken by review-stats script.

The ticket submitter failed to clear the NEEDINFO flag in a month.
As per https://fedoraproject.org/wiki/Policy_for_stalled_package_reviews
we consider this ticket as DEADREVIEW and proceed to close it.


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