Bug 2359651 - Review Request: rust-textdistance - Lots of algorithms to compare how similar two sequences are
Summary: Review Request: rust-textdistance - Lots of algorithms to compare how similar...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Linux
unspecified
medium
Target Milestone: ---
Assignee: Ben Beasley
QA Contact: Fedora Extras Quality Assurance
URL: https://crates.io/crates/textdistance
Whiteboard:
Depends On: 2330715
Blocks: 2359652
TreeView+ depends on / blocked
 
Reported: 2025-04-15 04:25 UTC by solomoncyj
Modified: 2025-12-08 02:13 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2025-12-08 02:13:35 UTC
Type: ---
Embargoed:
code: fedora-review+
solomoncyj: needinfo-


Attachments (Terms of Use)
The .spec file difference from Copr build 9688468 to 9709724 (365 bytes, patch)
2025-10-21 08:40 UTC, Fedora Review Service
no flags Details | Diff

Comment 1 Fedora Review Service 2025-04-15 04:26:45 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8904495
(failed)

Build log:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2359651-rust-textdistance/fedora-rawhide-x86_64/08904495-rust-textdistance/builder-live.log.gz

Please make sure the package builds successfully at least for Fedora Rawhide.

- If the build failed for unrelated reasons (e.g. temporary network
  unavailability), please ignore it.
- If the build failed because of missing BuildRequires, please make sure they
  are listed in the "Depends On" field


---
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 Ben Beasley 2025-10-13 12:43:20 UTC
Just took a quick preliminary look at this while waiting for bug 2330715.

> # FIXME: paste output of %%cargo_license_summary here
> License:        # FIXME

You have to actually fill in the License field, like https://src.fedoraproject.org/rpms/rust-oxipng/blob/ed81c4e3e89ad4858fc99f288d65678870b78a9a/f/rust-oxipng.spec#_36.

The command-line tool is not documented in the README, and practical testing suggests that it is not very polished, since it does not offer a usage message when I pass -h or --help, it ignores unexpected extra arguments, and it panics when it is passed too few arguments or a wrong algorithm name.

> # textdistance hamming boat boar
> 1
> # textdistance hamming boat boar asdf jhkl
> 1
> # textdistance foo bar bat 
> 
> thread 'main' panicked at src/main.rs:49:14:
> unknown algorithm name
> note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
> # textdistance hamming spam
> 
> thread 'main' panicked at src/main.rs:7:26:
> second text is required
> note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Honestly, I would be inclined to just ship only the library. This is easier for you anyway, since then you don’t have to deal with the License expression for the tool. In rust2rpm.toml, you could do something like:

> [package]
> # The command-line interface is not polished or well-documented, and it appears
> # to be intended primarily for experimentation during upstream development.
> cargo-install-bin = false

You should add comments explaining what the Cargo.toml metadata patch actually does:

> # Manually created patch for downstream crate metadata changes
> Patch:          textdistance-fix-metadata.diff

You can use rust2rpm.toml for this, too:

> [package]
> cargo-toml-patch-comments = [
>   "Allow older foo until we can update, RHBZ#12345678",
>   "Remove benchmark-only dev-dependency bar",
> ]

Comment 5 Ben Beasley 2025-10-14 09:05:41 UTC
Package Review
==============

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

The package is exactly as created by rust2rpm with a rust2rpm.toml that looks like

  [package]
  cargo-install-bin = false
  cargo-toml-patch-comments = [
    "remove criterion as it is a bench mark dep",
    "increase version bounds of rtest",
  ]

This greatly simplifies the review.


Issues:
=======
- Package does not contain duplicates in %files.
  Note: warning: File listed twice:
  /usr/share/cargo/registry/textdistance-1.1.1/LICENSE
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/#_duplicate_files

  This is due to reasonable design decisions in rust2rpm and is not a serious
  issue.

- You patched the rstest dependency, which is good, but you patched it to
  depend on the rust-rstest0.23 compat package, which was retired about a month
  ago and apparently hasn’t been blocked in Rawide and F43 branches as one
  would have expected, https://pagure.io/releng/issue/13009.

  Patch the rstest dependency to use version 0.26 instead. Note that almost all
  uses of rstest have proven to be compatible across SemVer bounds in practice,
  and 0.26 will work just fine for this package.

===== 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", "*No copyright* MIT License". 43 files
     have unknown license. Detailed output of licensecheck in
     /home/ben/fedora/review/2359651-rust-textdistance/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[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.
[x]: 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]: 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: No rpmlint messages.
[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]: 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.
     Note: Documentation size is 0 bytes in 0 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== 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.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in rust-
     textdistance-devel , rust-textdistance+default-devel , rust-
     textdistance+std-devel
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[x]: Package should compile and build into binary rpms on all supported
     architectures.

     https://koji.fedoraproject.org/koji/taskinfo?taskID=138136513

[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).
     See: (this test has no URL)
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.


Rpmlint
-------
Checking: rust-textdistance-devel-1.1.1-1.fc44.noarch.rpm
          rust-textdistance+default-devel-1.1.1-1.fc44.noarch.rpm
          rust-textdistance+std-devel-1.1.1-1.fc44.noarch.rpm
          rust-textdistance-1.1.1-1.fc44.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.7.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.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/tmpd32klhjr')]
checks: 32, packages: 4

 4 packages and 0 specfiles checked; 0 errors, 0 warnings, 19 filtered, 0 badness; has taken 0.2 s 




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.7.0
configuration:
    /usr/lib/python3.14/site-packages/rpmlint/configdefaults.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: 32, packages: 3

 3 packages and 0 specfiles checked; 0 errors, 0 warnings, 15 filtered, 0 badness; has taken 0.0 s 



Source checksums
----------------
https://crates.io/api/v1/crates/textdistance/1.1.1/download#/textdistance-1.1.1.crate :
  CHECKSUM(SHA256) this package     : aa672c55ab69f787dbc9126cc387dbe57fdd595f585e4524cf89018fa44ab819
  CHECKSUM(SHA256) upstream package : aa672c55ab69f787dbc9126cc387dbe57fdd595f585e4524cf89018fa44ab819


Requires
--------
rust-textdistance-devel (rpmlib, GLIBC filtered):
    cargo

rust-textdistance+default-devel (rpmlib, GLIBC filtered):
    cargo
    crate(textdistance)
    crate(textdistance/std)

rust-textdistance+std-devel (rpmlib, GLIBC filtered):
    cargo
    crate(textdistance)



Provides
--------
rust-textdistance-devel:
    crate(textdistance)
    rust-textdistance-devel

rust-textdistance+default-devel:
    crate(textdistance/default)
    rust-textdistance+default-devel

rust-textdistance+std-devel:
    crate(textdistance/std)
    rust-textdistance+std-devel



Diff spec file in url and in SRPM
---------------------------------
--- /home/ben/fedora/review/2359651-rust-textdistance/srpm/rust-textdistance.spec	2025-10-14 06:57:57.849705576 +0100
+++ /home/ben/fedora/review/2359651-rust-textdistance/srpm-unpacked/rust-textdistance.spec	2025-10-14 01:00:00.000000000 +0100
@@ -1,2 +1,12 @@
+## START: Set by rpmautospec
+## (rpmautospec version 0.8.1)
+## 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
+
 # Generated by rust2rpm 27
 %bcond check 1
@@ -85,3 +95,6 @@
 
 %changelog
-%autochangelog
+## START: Generated by rpmautospec
+* Tue Oct 14 2025 John Doe <packager> - 1.1.1-1
+- Uncommitted changes
+## END: Generated by rpmautospec


Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -L textdistance-deps/ -b 2359651
Buildroot used: fedora-rawhide-aarch64
Active plugins: Shell-api, Generic
Disabled plugins: C/C++, Perl, fonts, Java, Python, R, Haskell, Ocaml, PHP, SugarActivity
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH

Built with local dependencies:
    /home/ben/fedora/review/textdistance-deps/rust-assert2+default-devel-0.3.16-1.fc44.noarch.rpm
    /home/ben/fedora/review/textdistance-deps/rust-assert2-devel-0.3.16-1.fc44.noarch.rpm

Comment 6 Fedora Review Service 2025-10-14 18:12:02 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/9688467
(failed)

Build log:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2359651-rust-textdistance/fedora-rawhide-x86_64/09688467-rust-textdistance/builder-live.log.gz

Please make sure the package builds successfully at least for Fedora Rawhide.

- If the build failed for unrelated reasons (e.g. temporary network
  unavailability), please ignore it.
- If the build failed because of missing BuildRequires, please make sure they
  are listed in the "Depends On" field


---
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 7 Fedora Review Service 2025-10-14 18:14:40 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/9688468
(failed)

Build log:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2359651-rust-textdistance/fedora-rawhide-x86_64/09688468-rust-textdistance/builder-live.log.gz

Please make sure the package builds successfully at least for Fedora Rawhide.

- If the build failed for unrelated reasons (e.g. temporary network
  unavailability), please ignore it.
- If the build failed because of missing BuildRequires, please make sure they
  are listed in the "Depends On" field


---
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 9 Fedora Review Service 2025-10-21 08:40:43 UTC
Created attachment 2110344 [details]
The .spec file difference from Copr build 9688468 to 9709724

Comment 10 Fedora Review Service 2025-10-21 08:40:45 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/9709724
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2359651-rust-textdistance/fedora-rawhide-x86_64/09709724-rust-textdistance/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 11 Ben Beasley 2025-10-23 12:47:14 UTC
The submission is unchanged, except:

--- ../../srpm-unpacked/textdistance-fix-metadata.diff	2025-10-14 01:00:00.000000000 +0100
+++ srpm-unpacked/textdistance-fix-metadata.diff	2025-10-21 01:00:00.000000000 +0100
@@ -12,7 +12,7 @@
  
  [dev-dependencies.rstest]
 -version = "0.22.0"
-+version = ">=0.22.0, <0.24.0"
++version = ">=0.22.0, <0.27.0"
  
  [dev-dependencies.unicode-segmentation]
  version = "1.10.1"

This fixes the dependency on the retired rust-rstest0.23 package, which was the only finding in the previous review.

The package is therefore APPROVED.

===

Recommended post-import rust-sig tasks:

- set up package on release-monitoring.org:
  project: $crate
  homepage: https://crates.io/crates/$crate
  backend: crates.io
  version scheme: semantic
  version filter (*NOT* pre-release filter): alpha;beta;rc;pre
  distro: Fedora
  Package: rust-$crate

- add @rust-sig with "commit" access as package co-maintainer
  (should happen automatically)

- set bugzilla assignee overrides to @rust-sig (optional)

- track package in koschei for all built branches
  (should happen automatically once rust-sig is co-maintainer)

Comment 12 solomoncyj 2025-10-24 14:19:23 UTC
Thank you for the review, Ben

Comment 13 Fedora Admin user for bugzilla script actions 2025-10-24 14:45:55 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/rust-textdistance

Comment 14 Terje Rosten 2025-12-02 08:37:53 UTC
@solomoncyj what is status here?


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