Bug 1966766 - Review Request: python-toml-adapt - Adapt toml files
Summary: Review Request: python-toml-adapt - Adapt toml files
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ben Beasley
QA Contact: Ben Beasley
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-06-01 20:15 UTC by Iztok Fister Jr.
Modified: 2021-06-11 17:10 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-06-11 17:10:56 UTC
Type: ---
Embargoed:
code: fedora-review+


Attachments (Terms of Use)

Description Iztok Fister Jr. 2021-06-01 20:15:12 UTC
Spec URL: https://raw.githubusercontent.com/firefly-cpp/rpm-toml-adapt/main/python-toml-adapt.spec
SRPM URL: https://github.com/firefly-cpp/rpm-toml-adapt/raw/main/python-toml-adapt-0.1.0-1.fc33.src.rpm
Description: This is a very simple cli for manipulating toml files.

Fedora Account System Username: iztokf

Comment 1 Ben Beasley 2021-06-03 20:20:52 UTC
Package Review
==============

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


Issues:
=======
- Package contains BR: python2-devel or python3-devel

  You should BR: python3-devel, even with pyproject-rpm-macros.

- Since you are using generated BR’s, you do not need:

    BuildRequires: %{py3_dist lockfile}
    BuildRequires: %{py3_dist packaging}
    BuildRequires: %{py3_dist pep517}
    BuildRequires: %{py3_dist poetry-core}
    BuildRequires: %{py3_dist toml}

- The package BR’s make, but it is not actually needed. Please remove:

    BuildRequires:  make

- This:

    %{python3} -m pytest

  is better written as

    %pytest

  which sets some environment variables and ensures the installed package is
  used for testing.

- You have disabled the tests. You should enable them. (They do work.)

- You defined

    %global pretty_name toml_adapt

  but did not use it. You could, if you like, write

    %pyproject_save_files %{pretty_name}

  or just drop the macro since you would only use it once.

- While section names are case-insensitive,

    %builD

  would be better written as

    %build

- A man page for the CLI tool is not strictly required but is encouraged
  (https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages).

  While help2man does not do a good job here, I am happy to contribute a
  basic man page in groff_man(7) format if you are willing to maintain it,
  or can convince upstream to do so.

===== 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: "Expat License", "Unknown or generated". 7 files have unknown
     license. Detailed output of licensecheck in
     /home/reviewer/1966766-python-toml-adapt/licensecheck.txt
[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.
[-]: 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

     (except as noted)

[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 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.
[x]: Package meets the Packaging Guidelines::Python

     (except as noted)

[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]: Package functions as described.
[ ]: 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.
[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-toml-adapt-0.1.0-1.fc35.noarch.rpm
          python-toml-adapt-0.1.0-1.fc35.src.rpm
python3-toml-adapt.noarch: W: spelling-error %description -l en_US cli -> cl, clii, clip
python3-toml-adapt.noarch: W: no-manual-page-for-binary toml-adapt
python-toml-adapt.src: W: spelling-error %description -l en_US cli -> cl, clii, clip
python-toml-adapt.src: W: no-%build-section
python-toml-adapt.src:18: W: mixed-use-of-spaces-and-tabs (spaces: line 9, tab: line 18)
2 packages and 0 specfiles checked; 0 errors, 5 warnings.




Rpmlint (installed packages)
----------------------------
python3-toml-adapt.noarch: W: spelling-error %description -l en_US cli -> cl, clii, clip
python3-toml-adapt.noarch: W: no-manual-page-for-binary toml-adapt
1 packages and 0 specfiles checked; 0 errors, 2 warnings.



Source checksums
----------------
https://github.com/firefly-cpp/toml-adapt/archive/0.1.0/toml-adapt-0.1.0.tar.gz :
  CHECKSUM(SHA256) this package     : d9844753f017fb173f549fa45f57499203f49f4306f45efff2b4d24bf09803e6
  CHECKSUM(SHA256) upstream package : d9844753f017fb173f549fa45f57499203f49f4306f45efff2b4d24bf09803e6


Requires
--------
python3-toml-adapt (rpmlib, GLIBC filtered):
    (python3.9dist(toml) < 0.11 with python3.9dist(toml) >= 0.10.2)
    /usr/bin/python3
    python(abi)



Provides
--------
python3-toml-adapt:
    python-toml-adapt
    python3-toml-adapt
    python3.9-toml-adapt
    python3.9dist(toml-adapt)
    python3dist(toml-adapt)



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

Comment 2 Iztok Fister Jr. 2021-06-04 12:19:45 UTC
Dear Ben,

many thanks for your quick review. I have already corrected my initial version. Revision is Online:
  
SPEC: https://raw.githubusercontent.com/firefly-cpp/rpm-toml-adapt/main/python-toml-adapt.spec
  
SRPMS: https://github.com/firefly-cpp/rpm-toml-adapt/raw/main/python-toml-adapt-0.1.0-1.fc33.src.rpm
  
Note:
In fact, I am the upstream of this package too. Currently, software is far to be completed. My mission is to develop
a simple tool for manipulating toml files, so that I can have it as BR and use it in SPEC. In order to conduct serious
tests, I need to have it in rawhide.
  
Therefore, I would be extremely happy to have you as a contributor of a basic man page. You can submit a PR on my GitHub repo
and I add then man page in package later.

Comment 3 Ben Beasley 2021-06-05 12:20:36 UTC
PR as requested: https://github.com/firefly-cpp/toml-adapt/pull/1

I plan to finish the review later today.

Comment 4 Ben Beasley 2021-06-06 10:27:38 UTC
Thanks! This looks good. Package approved. Please do see the notes at the top of the re-review, below.

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

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

===== Notes =====

- This should never be required when using pyproject-rpm-macros, so you can
  remove it:

    rm -rf %{pretty_name}.egg-info

- When you later (after approval and intial import) package a release with
  https://github.com/firefly-cpp/toml-adapt/pull/1 included, you can add

    install -D -t '%{buildroot}%{_mandir}/man1' %{name}.1

  to the %install section, and

    %{_mandir}/man1/%{name}.1*

  to the %files section.

===== 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: "Expat License", "Unknown or generated". 7 files have unknown
     license. Detailed output of licensecheck in
     /home/reviewer/1966766-python-toml-adapt/review2/1966766-python-toml-
     adapt/licensecheck.txt
[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.
[-]: 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 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 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.
[x]: 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]: 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.
[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-toml-adapt-0.1.0-1.fc35.noarch.rpm
          python-toml-adapt-0.1.0-1.fc35.src.rpm
python3-toml-adapt.noarch: W: spelling-error %description -l en_US cli -> cl, clii, clip
python3-toml-adapt.noarch: W: no-manual-page-for-binary toml-adapt
python-toml-adapt.src: W: spelling-error %description -l en_US cli -> cl, clii, clip
2 packages and 0 specfiles checked; 0 errors, 3 warnings.




Rpmlint (installed packages)
----------------------------
python3-toml-adapt.noarch: W: spelling-error %description -l en_US cli -> cl, clii, clip
python3-toml-adapt.noarch: W: no-manual-page-for-binary toml-adapt
1 packages and 0 specfiles checked; 0 errors, 2 warnings.



Source checksums
----------------
https://github.com/firefly-cpp/toml-adapt/archive/0.1.0/toml-adapt-0.1.0.tar.gz :
  CHECKSUM(SHA256) this package     : d9844753f017fb173f549fa45f57499203f49f4306f45efff2b4d24bf09803e6
  CHECKSUM(SHA256) upstream package : d9844753f017fb173f549fa45f57499203f49f4306f45efff2b4d24bf09803e6


Requires
--------
python3-toml-adapt (rpmlib, GLIBC filtered):
    (python3.9dist(toml) < 0.11 with python3.9dist(toml) >= 0.10.2)
    /usr/bin/python3
    python(abi)



Provides
--------
python3-toml-adapt:
    python-toml-adapt
    python3-toml-adapt
    python3.9-toml-adapt
    python3.9dist(toml-adapt)
    python3dist(toml-adapt)



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

Comment 5 Ben Beasley 2021-06-06 10:38:34 UTC
Note that the Python 3.10 rebuild is in progress in Rawhide (and currently stalled due to an s390x builder outage); see https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/G47SGOYIQLRDTWGOSLSWERZSSHXDEDH5/.

If you import your package now, I’m not sure if it will be automatically included in the mass rebuild. If I were importing a new Python package into Rawhide during the rebuild, I would either explicitly build it into the side tag

  > fedpkg build --target f35-python

or avoid building it manually in Rawhide until the Python 3.10 side tag was merged.

Comment 6 Iztok Fister Jr. 2021-06-06 19:34:32 UTC
Ben, thank you very much for your help.

Comment 7 Gwyn Ciesla 2021-06-07 13:44:41 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-toml-adapt


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