Bug 1914637 - Review Request: python-boututils - Utils for post processing of BOUT++ simulations
Summary: Review Request: python-boututils - Utils for post processing of BOUT++ simula...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ben Beasley
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-01-10 13:25 UTC by david08741
Modified: 2021-06-28 22:00 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2021-06-28 22:00:44 UTC
Type: ---
Embargoed:
code: fedora-review+


Attachments (Terms of Use)
Example of using pyproject-rpm-macros (1.73 KB, text/x-matlab)
2021-01-12 21:01 UTC, Ben Beasley
no flags Details
Log showing installation error (248.43 KB, text/plain)
2021-01-22 21:02 UTC, Ben Beasley
no flags Details

Description david08741 2021-01-10 13:25:07 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/davidsch/testing/fedora-rawhide-x86_64/01874815-python-boututils/python-boututils.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/davidsch/testing/fedora-rawhide-x86_64/01874815-python-boututils/python-boututils-0.1.6-0.1.fc34.src.rpm

Description: Utils for post processing of BOUT++ simulation data
The package used to be part of bout++ - but was split out.

Thus it currently conflicts with bout++ - but the next version will not contain the files anymore, and a separate package is needed.

Fedora Account System Username: davidsch

Comment 1 Ben Beasley 2021-01-12 18:54:23 UTC
Package Review
==============

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

===== Issues =====

[!]: The %python_provides macro is obsolete and should be removed. If you are
     not building for Fedora 32, you do not need %py_provides either. See
     https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_provides.
[?]: This package could really benefit from using at least the portion of
     pyproject-rpm-macros that offers generated BuildRequires. This will give
     properly versioned BR’s, where applicable, and will keep you from
     forgetting to update them when upstream does. See
     https://src.fedoraproject.org/rpms/pyproject-rpm-macros. This is not
     mandatory.
[!]: You need to properly package the mayavi extra. See
     https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_python_extras.
[!]: You do not need to explicitly Require: (or Suggest:) the Python packages
     that are already in install_requires in setup.py. See
     https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_automatically_generated_dependencies.
[x]: Conflicts with python3-bout++ are acceptable because this is being split
     out from bout++ and the problem will be promptly resolved. Please use
     multi-build updates to update both packages together:
     https://docs.fedoraproject.org/en-US/rawhide-gating/multi-builds/
[!]: Package has (a single trivial) test but there is no %check section. To run
     the tests, add a BR on python3dist(pytest) and use the %pytest macro to
     run the tests. Or, in this case, just %{python3} -m unittest ought to work.
[!]: Modules inside the package (anim.py, boutgrid.py, geqdsk.py) have shebang
     lines. This does not make sense since they are not installed as
     executables. Remove the shebang lines in %prep, e.g. by:

     sed -r -i '1{/#!/d}' %{pypi_name}/{anim,boutgrid,geqdsk}.py


===== 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", "GNU Lesser General Public License,
     Version 3", "*No copyright* GNU Lesser General Public License v3.0 or
     later". 45 files have unknown license. Detailed output of licensecheck
     in /home/ben/src/fedora/reviews/boututils/1914637-python-
     boututils/licensecheck.txt
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.9/site-
     packages/boututils(python3-bout++), /usr/lib/python3.9/site-
     packages/boututils/__pycache__(python3-bout++)

     Conflicts with python3-bout++ are acceptable because this is being split
     out from bout++ and the problem will be promptly resolved. Please use
     multi-build updates to update both packages together.

     https://docs.fedoraproject.org/en-US/rawhide-gating/multi-builds/

[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.

     Conflicts with python3-bout++ are acceptable because this is being split
     out from bout++ and the problem will be promptly resolved. Please use
     multi-build updates to update both packages together.

     https://docs.fedoraproject.org/en-US/rawhide-gating/multi-builds/

[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.

     Should not duplicate Requires that are already handled by the automatic
     dependency generator.

[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 10240 bytes in 1 files.
[!]: Package complies to the Packaging Guidelines

     (Issues noted elsewhere)

[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[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 requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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

     (Issues noted elsewhere)

[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.
[!]: Final provides and requires are sane (see attachments).

     Duplicate manual Requires with automatic ones. Results in both
     python3dist(foo) and python3.9dist(foo). This works but the duplication
     should not be there.

[ ]: 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.
[!]: %check is present and all tests pass.

     Package has (a single trivial) test but there is no %check section. To run
     the tests, add a BR on python3dist(pytest) and use the %pytest macro to
     run the tests. Or, in this case, just %{python3} -m unittest ought to work.

[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:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-boututils-0.1.6-0.1.fc34.noarch.rpm
          python-boututils-0.1.6-0.1.fc34.src.rpm
python3-boututils.noarch: W: spelling-error %description -l en_US Utils -> Tills
python3-boututils.noarch: W: description-shorter-than-summary
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/anim.py 644 /usr/bin/env python3
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/boutgrid.py 644 /usr/bin/env python3
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/geqdsk.py 644 /usr/bin/env python3
python-boututils.src: W: spelling-error %description -l en_US Utils -> Tills
python-boututils.src: W: description-shorter-than-summary
2 packages and 0 specfiles checked; 3 errors, 4 warnings.




Rpmlint (installed packages)
----------------------------
python3-boututils.noarch: W: spelling-error %description -l en_US Utils -> Tills
python3-boututils.noarch: W: description-shorter-than-summary
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/anim.py 644 /usr/bin/env python3
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/boutgrid.py 644 /usr/bin/env python3
python3-boututils.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/boututils/geqdsk.py 644 /usr/bin/env python3
1 packages and 0 specfiles checked; 3 errors, 2 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/b/boututils/boututils-0.1.6.tar.gz :
  CHECKSUM(SHA256) this package     : 0be867137f0ac8ddeadde0588bca0c67750f27a33a28ff94fe925c4f4c99609c
  CHECKSUM(SHA256) upstream package : 0be867137f0ac8ddeadde0588bca0c67750f27a33a28ff94fe925c4f4c99609c


Requires
--------
python3-boututils (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(future)
    python3.9dist(h5py)
    python3.9dist(matplotlib)
    python3.9dist(netcdf4)
    python3.9dist(numpy)
    python3.9dist(scipy)
    python3dist(future)
    python3dist(matplotlib)
    python3dist(netcdf4)
    python3dist(numpy)
    python3dist(pyqt5)
    python3dist(scipy)



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



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

Comment 2 Ben Beasley 2021-01-12 21:01:22 UTC
Created attachment 1746808 [details]
Example of using pyproject-rpm-macros

Comment 3 Ben Beasley 2021-01-12 21:01:25 UTC
I’m attaching an example spec file that uses the pyproject-rpm-macros to show what it would look like. I think it addresses the other issues too, although I haven’t re-reviewed it closely. You certainly don’t have to use my version (although you may), and if you do use the pyproject-rpm-macros, you can use the generated BR’s without the other macros. Still, I thought it would be helpful.

Comment 4 david08741 2021-01-22 19:01:37 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/davidsch/testing/fedora-rawhide-x86_64/01897447-python-boututils/python-boututils.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/davidsch/testing/fedora-rawhide-x86_64/01897447-python-boututils/python-boututils-0.1.7-0.1.fc34.src.rpm

Thanks, the pyproject-rpm-macros are quite nice.

I removed the shebangs upstream, so that isn't needed anymore.

I don't think the extra package isn't required[1], but added it anyway.

Thanks for the review.

Comment 5 Ben Beasley 2021-01-22 21:00:54 UTC
Thanks, approved. Changes from original review below:

===== Issues =====

All previous issues remedied.

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

  See attached root.log. I have determined that the problem is actually in
  python3-pyface, which gets brought in by the mayavi extra. I also tested
  installing the main package manually and confirmed it installs properly.
  Therefore, there is no problem with your submission.

  Instead, I filed https://bugzilla.redhat.com/show_bug.cgi?id=1919444.

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

Generic:
[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", "GNU Lesser General Public License,
     Version 3", "*No copyright* GNU Lesser General Public License v3.0 or
     later". 47 files have unknown license. Detailed output of licensecheck
     in /home/reviewer/1914637-python-boututils/licensecheck.txt
[x]: Package complies to the Packaging Guidelines

Python:
[x]: Package meets the Packaging Guidelines::Python
[x]: Final provides and requires are sane (see attachments).

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

Generic:
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-boututils , python3-boututils+mayavi
[x]: Package functions as described.
     (That should have been marked before.)
[x]: %check is present and all tests pass.

===== 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

     This is due to the python3-pyface bug
     https://bugzilla.redhat.com/show_bug.cgi?id=1919444, not a
     defect in this submission. Therefore it should be a PASS [x].

Installation errors
-------------------
INFO: mock.py version 2.8 starting (python version = 3.9.1, NVR = mock-2.8-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.8
INFO: Mock Version: 2.8
Finish: chroot init
INFO: installing package(s): /home/reviewer/1914637-python-boututils/results/python3-boututils-0.1.7-0.1.fc34.noarch.rpm /home/reviewer/1914637-python-boututils/results/python3-boututils+mayavi-0.1.7-0.1.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/1914637-python-boututils/results/python3-boututils-0.1.7-0.1.fc34.noarch.rpm /home/reviewer/1914637-python-boututils/results/python3-boututils+mayavi-0.1.7-0.1.fc34.noarch.rpm --setopt=tsflags=nocontexts



Rpmlint
-------
Checking: python3-boututils-0.1.7-0.1.fc34.noarch.rpm
          python3-boututils+mayavi-0.1.7-0.1.fc34.noarch.rpm
          python-boututils-0.1.7-0.1.fc34.src.rpm
python3-boututils.noarch: W: spelling-error %description -l en_US Utils -> Tills
python3-boututils.noarch: W: description-shorter-than-summary
python3-boututils+mayavi.noarch: W: spelling-error Summary(en_US) Metapackage -> Meta package, Meta-package, Prepackage
python3-boututils+mayavi.noarch: W: spelling-error Summary(en_US) boututils -> boutiques
python3-boututils+mayavi.noarch: W: spelling-error Summary(en_US) mayavi -> mayday
python3-boututils+mayavi.noarch: W: spelling-error %description -l en_US metapackage -> meta package, meta-package, prepackage
python3-boututils+mayavi.noarch: W: spelling-error %description -l en_US mayavi -> mayday
python3-boututils+mayavi.noarch: W: spelling-error %description -l en_US boututils -> boutiques
python3-boututils+mayavi.noarch: W: no-documentation
python-boututils.src: W: spelling-error %description -l en_US Utils -> Tills
python-boututils.src: W: spelling-error %description -l en_US postprocessing -> post processing, post-processing, teleprocessing
3 packages and 0 specfiles checked; 0 errors, 11 warnings.




Source checksums
----------------
https://files.pythonhosted.org/packages/source/b/boututils/boututils-0.1.7.tar.gz :
  CHECKSUM(SHA256) this package     : 84f22fe0271bad5fd1490088c16b9894557d199821d84d1acc15cc1ac6b935bf
  CHECKSUM(SHA256) upstream package : 84f22fe0271bad5fd1490088c16b9894557d199821d84d1acc15cc1ac6b935bf


Requires
--------
python3-boututils (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(future)
    python3.9dist(h5py)
    python3.9dist(matplotlib)
    python3.9dist(netcdf4)
    python3.9dist(numpy)
    python3.9dist(scipy)

python3-boututils+mayavi (rpmlib, GLIBC filtered):
    python(abi)
    python3-boututils
    python3.9dist(mayavi)
    python3.9dist(pyqt5)



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

python3-boututils+mayavi:
    python-boututils+mayavi
    python3-boututils+mayavi
    python3.9-boututils+mayavi
    python3.9dist(boututils[mayavi])
    python3dist(boututils[mayavi])



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

Comment 6 Ben Beasley 2021-01-22 21:02:03 UTC
Created attachment 1749881 [details]
Log showing installation error

This shows that the error installing python3-boututils+mayavi-0.1.7-0.1.fc34.noarch.rpm is due to a problem with the indirect dependency python3-pyface, not a defect in this package.

Comment 7 Mohan Boddu 2021-02-02 20:49:59 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-boututils

Comment 8 david08741 2021-06-28 22:00:44 UTC
Thanks again for the review.

https://bodhi.fedoraproject.org/updates/FEDORA-2021-f5d796aff7


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