Bug 2107842 - Review Request: python-whatthepatch - A patch parsing and application library
Summary: Review Request: python-whatthepatch - A patch parsing and application library
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Miro Hrončok
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-07-16 17:58 UTC by Mukundan Ragavan
Modified: 2022-07-18 12:52 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-07-18 12:52:03 UTC
Type: ---
Embargoed:
mhroncok: fedora-review+


Attachments (Terms of Use)

Description Mukundan Ragavan 2022-07-16 17:58:17 UTC
Spec URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-whatthepatch/python-whatthepatch.spec
SRPM URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-whatthepatch/python-whatthepatch-1.0.2-1.fc36.src.rpm


Description:
What The Patch!? What The Patch!? is a library for both parsing and applying
patch files.

Fedora Account System Username: nonamedotc

Comment 1 Mukundan Ragavan 2022-07-16 17:59:32 UTC
koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=89578728

Comment 2 Miro Hrončok 2022-07-16 20:22:35 UTC
Spec sanity:

> %global pypi_name whatthepatch
> %global pypi_version 1.0.2

In my opinion, defining this on top makes the spec file harder to read later, albeit that is my opinionated view.



> %global _description ...

Defining his at the top is a bit untraditional, I would very much prefer if you stick to the order in https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_example_spec_file but again, that is my opinionated view.


> BuildRequires:  pyproject-rpm-macros

This is not necessary as the macros are pulled by python3-devel. However, it is not forbidden.



> BuildRequires:  python3dist(setuptools)

This should not be necessary, as the build backend is BuildRequired by %pyproject_buildrequires. Manual dependencies, when otherwise generated, SHOULD not be used.



> %{?python_provide:%python_provide python3-%{pypi_name}}

This is deprecated and SHOULD not be used.


> %description -n python3-%{pypi_name}
> %_description

I suppose this puts an extra empty line at the beginning of the description, which is probably undesired.



> %pyproject_buildrequires -x all,test

I see no all or test extras in this software. Please verify this.




> %files -n python3-%{pypi_name}
> %license LICENSE
> %doc README.rst
> %{python3_sitelib}/%{pypi_name}
> %{python3_sitelib}/%{pypi_name}-%{pypi_version}.dist-info

Consider using %pyproject_save_files and %{pyproject_files}? However, that remains optional.

Comment 4 Mukundan Ragavan 2022-07-16 20:41:39 UTC
Thanks for the comments.


(In reply to Miro Hrončok from comment #2)
> Spec sanity:
> 
> > %global pypi_name whatthepatch
> > %global pypi_version 1.0.2
> 
> In my opinion, defining this on top makes the spec file harder to read
> later, albeit that is my opinionated view.
> 
> 

I actually prefer declaring this at the top.


I have changed everything else as pointed out and have updated the SPEC and SRPM.

Comment 5 Miro Hrončok 2022-07-17 10:53:24 UTC
> %license LICENSE

I get the feeling that this is now duplicated, but I haven't actually checked yet.



> Source0:        %{pypi_source}

I haven't noticed this before, but just a nitpick: the number 0 is redundant.



Will run fedora-review.

Comment 6 Miro Hrončok 2022-07-17 11:01:23 UTC
(In reply to Miro Hrončok from comment #5)
> > %license LICENSE
> 
> I get the feeling that this is now duplicated, but I haven't actually
> checked yet.

Indeed:

$ rpm -qpl --licensefiles python3-whatthepatch-1.0.2-2.fc37.noarch.rpm 
/usr/lib/python3.11/site-packages/whatthepatch-1.0.2.dist-info/LICENSE
/usr/share/licenses/python3-whatthepatch/LICENSE

Please remove the %license LICENSE line.


---------------


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

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


Issues:

 1) python3-whatthepatch.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python3-whatthepatch/README.rst
 2) duplicated %license file



===== 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: "MIT License", "Unknown or generated", "*No copyright* MIT
     License".
[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).
[?]: 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.
[?]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[?]: 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 (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

python3-whatthepatch.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python3-whatthepatch/README.rst
 1 packages and 0 specfiles checked; 0 errors, 1 warnings, 0 badness; has taken 0.0 s 



Source checksums
----------------
https://files.pythonhosted.org/packages/source/w/whatthepatch/whatthepatch-1.0.2.tar.gz :
  CHECKSUM(SHA256) this package     : c540ea59173e0a291e19c742dd8b406c56e2be039a600edb7c6fc3ae4bbdfa9f
  CHECKSUM(SHA256) upstream package : c540ea59173e0a291e19c742dd8b406c56e2be039a600edb7c6fc3ae4bbdfa9f


Requires
--------
python3-whatthepatch (rpmlib, GLIBC filtered):
    python(abi)


BuildRequires
-------------
    pyproject-rpm-macros
    python3-devel
    python3dist(packaging)
    python3dist(pip) >= 19
    python3dist(pytest)
    python3dist(setuptools) >= 40.8
    python3dist(wheel)
    rpmlib(CompressedFileNames) <= 3.0.4-1
    rpmlib(DynamicBuildRequires) <= 4.15.0-1
    rpmlib(FileDigests) <= 4.6.0-1


Provides
--------
python3-whatthepatch:
    python-whatthepatch
    python3-whatthepatch
    python3.11-whatthepatch
    python3.11dist(whatthepatch)
    python3dist(whatthepatch)



Generated by fedora-review 0.7.0 (fed5495) last change: 2019-03-17
Command line :try-fedora-review -b 2107842 -m fedora-rawhide-x86_64
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: PHP, R, fonts, SugarActivity, C/C++, Haskell, Perl, Java, Ruby, Ocaml
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 7 Mukundan Ragavan 2022-07-17 14:01:55 UTC
Updated SPEC URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-whatthepatch/python-whatthepatch.spec
Updated SRPM URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/python-whatthepatch/python-whatthepatch-1.0.2-3.fc36.src.rpm




Fixed both issues.

$ rpmlint python3-whatthepatch-1.0.2-3.fc37.noarch.rpm 
============================ rpmlint session starts ============================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.10/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

 1 packages and 0 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 0.0 s 


$ rpm -qlp python3-whatthepatch-1.0.2-3.fc37.noarch.rpm | grep -i license
/usr/lib/python3.11/site-packages/whatthepatch-1.0.2.dist-info/LICENSE

Comment 8 Miro Hrončok 2022-07-17 14:35:43 UTC
Package approved.

Comment 9 Mukundan Ragavan 2022-07-17 17:11:50 UTC
Thanks for the review.

Comment 10 Tomas Hrcka 2022-07-18 05:54:53 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-whatthepatch


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