Bug 2244877 - Review Request: python-nh3 - Python bindings to the Rust ammonia crate
Summary: Review Request: python-nh3 - Python bindings to the Rust ammonia crate
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Fabio Valentini
QA Contact: Fedora Extras Quality Assurance
URL: https://github.com/messense/nh3
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-10-18 17:43 UTC by Mattia Verga
Modified: 2023-10-21 15:46 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2023-10-21 15:46:22 UTC
Type: ---
Embargoed:
decathorpe: fedora-review+


Attachments (Terms of Use)

Description Mattia Verga 2023-10-18 17:43:51 UTC
Spec URL: https://mattia.fedorapeople.org/nh3/python-nh3.spec
SRPM URL: https://mattia.fedorapeople.org/nh3/python-nh3-0.2.14-1.fc40.src.rpm
Description: Python binding to Ammonia HTML sanitizer Rust crate.
Fedora Account System Username: mattia

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

Comment 1 Fedora Review Service 2023-10-18 17:53:12 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6544361
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2244877-python-nh3/fedora-rawhide-x86_64/06544361-python-nh3/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 2 Fabio Valentini 2023-10-20 17:41:31 UTC
Looks good to me, with some small issues:

1.

> # https://fedoraproject.org/wiki/Changes/EncourageI686LeafRemoval
> ExcludeArch:    %{ix86}

Please remove this.
It will cause problems for any (noarch) Python packages that depend on python3-nh3 if they ever are unlucky and get scheduled to run on an i686 builder.

2.

I would recommend to move this:

License:        MIT AND Apache-2.0 AND (MIT OR Apache-2.0) AND (Zlib OR Apache-2.0 OR MIT)
# Full license breakdown in LICENSES.dependencies

To the python3-nh3 subpackage, and keep the License tag of the "main" package as just MIT to document the license of nh3 itself.

Comment 3 Fabio Valentini 2023-10-20 17:44:08 UTC
Also, you might want to improve the description.
"Python bindings to the Rust ammonia crate" means nothing if you don't know the "ammonia" crate. :)

Comment 4 Mattia Verga 2023-10-21 09:23:34 UTC
(In reply to Fabio Valentini from comment #2)
> Looks good to me, with some small issues:
> 
> 1.
> 
> > # https://fedoraproject.org/wiki/Changes/EncourageI686LeafRemoval
> > ExcludeArch:    %{ix86}
> 
> Please remove this.
> It will cause problems for any (noarch) Python packages that depend on
> python3-nh3 if they ever are unlucky and get scheduled to run on an i686
> builder.
> 

Crap, I always forgot about that... both fixed in

Spec URL: https://mattia.fedorapeople.org/nh3/python-nh3.spec
SRPM URL: https://mattia.fedorapeople.org/nh3/python-nh3-0.2.14-2.fc40.src.rpm

Comment 5 Fabio Valentini 2023-10-21 10:11:49 UTC
Package Review
==============

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

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

C/C++:
[x]: Development (unversioned) .so files in -devel subpackage, if present.

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.
[x]: License file installed when any subpackage combination is installed.
[x]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[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.
[-]: 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]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[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.
[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]: The License field must be a valid SPDX expression.
[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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[-]: Binary eggs must be removed in %prep
[-]: Python eggs must not download any dependencies during the build
     process.
[-]: 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

===== 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).
[-]: Fully versioned dependency in subpackages if applicable.
[?]: 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.
[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:
[!]: Spec file according to URL is the same as in SRPM.
     Note: Spec file as given by url is not the same as in SRPM (see
     attached diff).
[x]: Rpmlint is run on all installed packages.
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.


Rpmlint
-------
Checking: python3-nh3-0.2.14-1.fc40.x86_64.rpm
          python-nh3-debugsource-0.2.14-1.fc40.x86_64.rpm
          python-nh3-0.2.14-1.fc40.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpcj03uf7n')]
checks: 31, packages: 3

python-nh3.src: W: strange-permission python-nh3.spec 600
 3 packages and 0 specfiles checked; 0 errors, 1 warnings, 0 badness; has taken 0.4 s 


Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 31, packages: 2

python3-nh3.x86_64: W: undefined-non-weak-symbol (...)
 2 packages and 0 specfiles checked; 0 errors, 60 warnings, 0 badness; has taken 0.1 s 


Unversioned so-files
--------------------
python3-nh3: /usr/lib64/python3.12/site-packages/nh3/nh3.abi3.so


Source checksums
----------------
https://files.pythonhosted.org/packages/source/n/nh3/nh3-0.2.14.tar.gz :
  CHECKSUM(SHA256) this package     : a0c509894fd4dccdff557068e5074999ae3b75f4c5a2d6fb5415e782e25679c4
  CHECKSUM(SHA256) upstream package : a0c509894fd4dccdff557068e5074999ae3b75f4c5a2d6fb5415e782e25679c4


Requires
--------
python3-nh3 (rpmlib, GLIBC filtered):
    ld-linux-x86-64.so.2()(64bit)
    libc.so.6()(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgcc_s.so.1(GCC_3.3)(64bit)
    libgcc_s.so.1(GCC_4.2.0)(64bit)
    python(abi)
    rtld(GNU_HASH)

python-nh3-debugsource (rpmlib, GLIBC filtered):


Provides
--------
python3-nh3:
    python-nh3
    python3-nh3
    python3-nh3(x86-64)
    python3.12-nh3
    python3.12dist(nh3)
    python3dist(nh3)

python-nh3-debugsource:
    python-nh3-debugsource
    python-nh3-debugsource(x86-64)


Diff spec file in url and in SRPM
---------------------------------
--- /home/deca/Downloads/2244877-python-nh3/srpm/python-nh3.spec	2023-10-20 19:30:33.540562437 +0200
+++ /home/deca/Downloads/2244877-python-nh3/srpm-unpacked/python-nh3.spec	2023-10-18 02:00:00.000000000 +0200
@@ -1,2 +1,12 @@
+## START: Set by rpmautospec
+## (rpmautospec version 0.3.5)
+## RPMAUTOSPEC: autorelease, autochangelog
+%define autorelease(e:s:pb:n) %{?-p:0.}%{lua:
+    release_number = 1;
+    base_release_number = tonumber(rpm.expand("%{?-b*}%{!?-b:1}"));
+    print(release_number + base_release_number - 1);
+}%{?-e:.%{-e*}}%{?-s:.%{-s*}}%{!?-n:%{?dist}}
+## END: Set by rpmautospec
+
 Name:           python-nh3
 Version:        0.2.14
@@ -62,3 +72,4 @@
 
 %changelog
-%autochangelog
+* Wed Oct 18 2023 Mattia Verga <mattia.verga> - 0.2.14-1
+- Initial release


================================================================================

Additional comments:

1. python3-nh3.x86_64: W: undefined-non-weak-symbol (...)

This is normal for "plugins", as far as I know.

2. Spec file according to URL is the same as in SRPM.

This is normal for rpmautospec packages. Just take care to import the correct
spec file.

================================================================================

I recommend setting up release-monitoring and koschei for this package.
If you want, you can also add @rust-sig and @python-packagers-sig with commit
access to the package.

Comment 6 Fedora Admin user for bugzilla script actions 2023-10-21 15:29:54 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-nh3

Comment 7 Fedora Update System 2023-10-21 15:44:14 UTC
FEDORA-2023-a84134c115 has been submitted as an update to Fedora 40. https://bodhi.fedoraproject.org/updates/FEDORA-2023-a84134c115

Comment 8 Fedora Update System 2023-10-21 15:46:22 UTC
FEDORA-2023-a84134c115 has been pushed to the Fedora 40 stable repository.
If problem still persists, please make note of it in this bug report.


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