[Bug 2251482] New: Review Request: fawltydeps - Find undeclared and unused 3rd-party dependencies in your Python project
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
Bug ID: 2251482 Summary: Review Request: fawltydeps - Find undeclared and unused 3rd-party dependencies in your Python project Product: Fedora Version: rawhide Hardware: All OS: Linux Status: NEW Component: Package Review Severity: medium Priority: medium Assignee: nobody@fedoraproject.org Reporter: gui1ty@penguinpee.nl QA Contact: extras-qa@fedoraproject.org CC: package-review@lists.fedoraproject.org Target Milestone: --- Classification: Fedora
Spec URL: https://download.copr.fedorainfracloud.org/results/gui1ty/reviews/fedora-raw... SRPM URL: https://download.copr.fedorainfracloud.org/results/gui1ty/reviews/fedora-raw...
Description: FawltyDeps is a dependency checker for Python that finds undeclared and/or unused 3rd-party dependencies in your Python project. The name is inspired by the Monty Python-adjacent Fawlty Towers sitcom.
Fedora Account System Username: guilty
Copr build: https://copr.fedorainfracloud.org/coprs/gui1ty/reviews/build/6693699/
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Doc Type|--- |If docs needed, set a value Status|NEW |ASSIGNED Flags| |fedora-review? CC| |code@musicinmybrain.net Assignee|nobody@fedoraproject.org |code@musicinmybrain.net
--- Comment #1 from Ben Beasley code@musicinmybrain.net --- Package Review ==============
Legend: [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
Issues: ======= - Dist tag is present.
OK: fedora-review still doesn’t quite understand rpmautospec.
- Consider generating a man page with help2man, which does a pretty good job in this case.
fawltydeps.noarch: W: no-manual-page-for-binary fawltydeps
https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages
This isn’t mandatory, but is helpful.
- This is in the description:
Provides: python3-%{name}-%{version}
Note:
fawltydeps.noarch: W: tag-in-description Provides:
Move it up in the spec file so it’s where it belongs, and change it to:
%py_provides python3-fawltydeps
See:
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_provides_...
Or, since it looks like the package is not intended to be used as a library with "import fawltydeps" at all, but instead the library exists purely to support the command-line tool, you may choose to omit this line.
===== 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", "MIT License". 111 files have unknown license. Detailed output of licensecheck in /home/ben/Downloads/review/2251482-fawltydeps/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 27361 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]: 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]: 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: [-]: Binary eggs must be removed in %prep Note: Cannot find any build in BUILD directory (--prebuilt option?) [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
===== 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.
(tests pass)
[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. [?]: 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]: Spec use %global instead of %define unless justified. Note: %define requiring justification: %define autorelease(e:s:pb:n) %{?-p:0.}%{lua:
%define is from rpmautospec expansion
[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.
===== 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: fawltydeps-0.13.3-1.fc40.noarch.rpm fawltydeps-0.13.3-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/tmpdnijpjiw')] checks: 31, packages: 2
fawltydeps.noarch: W: tag-in-description Provides: fawltydeps.src: W: tag-in-description Provides: fawltydeps.noarch: W: no-manual-page-for-binary fawltydeps ================ 2 packages and 0 specfiles checked; 0 errors, 3 warnings, 0 badness; has taken 0.5 s ================
Rpmlint (installed packages) ---------------------------- ============================ rpmlint session starts ============================ rpmlint: 2.5.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: 32, packages: 1
fawltydeps.noarch: W: tag-in-description Provides: fawltydeps.noarch: W: python-missing-require importlib_metadata fawltydeps.noarch: W: python-missing-require isort fawltydeps.noarch: W: python-missing-require pip-requirements-parser fawltydeps.noarch: W: python-missing-require pydantic fawltydeps.noarch: W: python-missing-require setuptools fawltydeps.noarch: W: no-manual-page-for-binary fawltydeps 1 packages and 0 specfiles checked; 0 errors, 7 warnings, 3 filtered, 0 badness; has taken 0.1 s
Source checksums ---------------- https://github.com/tweag/FawltyDeps/archive/v0.13.3/FawltyDeps-0.13.3.tar.gz : CHECKSUM(SHA256) this package : d4036fd3a3bd9b08526a12ae1eb0e91557c353128c60cb47184fe613c52bcbdd CHECKSUM(SHA256) upstream package : d4036fd3a3bd9b08526a12ae1eb0e91557c353128c60cb47184fe613c52bcbdd
Requires -------- fawltydeps (rpmlib, GLIBC filtered): (python3.12dist(isort) < 6~~ with python3.12dist(isort) >= 5.10) (python3.12dist(pip-requirements-parser) < 33~~ with python3.12dist(pip-requirements-parser) >= 32.0.1) (python3.12dist(pydantic) < 3~~ with python3.12dist(pydantic) >= 1.10.2) (python3.12dist(setuptools) < 69~~ with python3.12dist(setuptools) >= 65.5.1) /usr/bin/python3 python(abi) python3.12dist(importlib-metadata)
Provides -------- fawltydeps: fawltydeps python3.12dist(fawltydeps) python3dist(fawltydeps)
Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24 Command line :/usr/bin/fedora-review -b 2251482 Buildroot used: fedora-rawhide-x86_64 Active plugins: Python, Generic, Shell-api Disabled plugins: Haskell, PHP, Java, SugarActivity, Perl, C/C++, R, Ocaml, fonts Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
--- Comment #2 from Sandro gui1ty@penguinpee.nl --- Thanks for the review.
I decided to drop the virtual provide since, indeed, the library doesn't appear to be useful by itself. I added a man page for fawltydeps as suggested.
Spec URL: https://download.copr.fedorainfracloud.org/results/gui1ty/reviews/fedora-raw... SRPM URL: https://download.copr.fedorainfracloud.org/results/gui1ty/reviews/fedora-raw...
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
--- Comment #3 from Fedora Review Service fedora-review-bot@fedoraproject.org --- Copr build: https://copr.fedorainfracloud.org/coprs/build/6909895 (succeeded)
Review template: https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-rev...
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.
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
Ben Beasley code@musicinmybrain.net changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags|fedora-review? |fedora-review+
--- Comment #4 from Ben Beasley code@musicinmybrain.net --- The spec-file diff is
diff -Naur ./srpm-unpacked/fawltydeps.spec 2251482-fawltydeps/srpm-unpacked/fawltydeps.spec --- ./srpm-unpacked/fawltydeps.spec 2023-11-24 19:00:00.000000000 -0500 +++ 2251482-fawltydeps/srpm-unpacked/fawltydeps.spec 2024-01-15 19:00:00.000000000 -0500 @@ -1,8 +1,8 @@ ## START: Set by rpmautospec -## (rpmautospec version 0.3.5) +## (rpmautospec version 0.3.8) ## RPMAUTOSPEC: autorelease, autochangelog %define autorelease(e:s:pb:n) %{?-p:0.}%{lua: - release_number = 1; + release_number = 2; base_release_number = tonumber(rpm.expand("%{?-b*}%{!?-b:1}")); print(release_number + base_release_number - 1); }%{?-e:.%{-e*}}%{?-s:.%{-s*}}%{!?-n:%{?dist}} @@ -23,6 +23,8 @@
BuildArch: noarch BuildRequires: python3-devel +# For generating man pages +BuildRequires: help2man %if %{with tests} BuildRequires: python3-pytest BuildRequires: python3-hypothesis @@ -35,8 +37,6 @@
%description %_description
-Provides: python3-%{name}-%{version} -
%prep %forgeautosetup -p1 @@ -61,6 +61,13 @@ %pyproject_install %pyproject_save_files %{name}
+# Create man pages from --help and --version +mkdir man +%{py3_test_envvars} help2man --section 1 --no-discard-stderr \ +--no-info --output man/%{name}.1 %{name} +mkdir -p %{buildroot}%{_mandir}/man1 +install -m 0644 man/%{name}.1 %{buildroot}%{_mandir}/man1 +
%check %if %{with tests} @@ -79,8 +86,14 @@ %doc README.* %license LICENSE %{_bindir}/%{name} +%{_mandir}/man1/%{name}.1*
%changelog +## START: Generated by rpmautospec +* Tue Jan 16 2024 Sandro devel@penguinpee.nl - 0.13.3-2 +- Add man page and drop Provides: + * Sat Nov 25 2023 Sandro devel@penguinpee.nl - 0.13.3-1 - Initial package +## END: Generated by rpmautospec
This correctly implements the requested changes. Furthermore, the rpmlint output in the new review.txt template does not reveal any new issues:
Rpmlint ------- Checking: fawltydeps-0.13.3-2.fc40.noarch.rpm fawltydeps-0.13.3-2.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/tmpe1x63j0s')] checks: 31, packages: 2
2 packages and 0 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 0.5 s
Rpmlint (installed packages) ---------------------------- ============================ rpmlint session starts ============================ rpmlint: 2.5.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: 32, packages: 1
fawltydeps.noarch: W: python-missing-require importlib_metadata fawltydeps.noarch: W: python-missing-require isort fawltydeps.noarch: W: python-missing-require pip-requirements-parser fawltydeps.noarch: W: python-missing-require pydantic fawltydeps.noarch: W: python-missing-require setuptools 1 packages and 0 specfiles checked; 0 errors, 5 warnings, 3 filtered, 0 badness; has taken 0.1 s
Source checksums ---------------- https://github.com/tweag/FawltyDeps/archive/v0.13.3/FawltyDeps-0.13.3.tar.gz : CHECKSUM(SHA256) this package : d4036fd3a3bd9b08526a12ae1eb0e91557c353128c60cb47184fe613c52bcbdd CHECKSUM(SHA256) upstream package : d4036fd3a3bd9b08526a12ae1eb0e91557c353128c60cb47184fe613c52bcbdd
Requires -------- fawltydeps (rpmlib, GLIBC filtered): (python3.12dist(isort) < 6~~ with python3.12dist(isort) >= 5.10) (python3.12dist(pip-requirements-parser) < 33~~ with python3.12dist(pip-requirements-parser) >= 32.0.1) (python3.12dist(pydantic) < 3~~ with python3.12dist(pydantic) >= 1.10.2) (python3.12dist(setuptools) < 69~~ with python3.12dist(setuptools) >= 65.5.1) /usr/bin/python3 python(abi) python3.12dist(importlib-metadata)
Provides -------- fawltydeps: fawltydeps python3.12dist(fawltydeps) python3dist(fawltydeps)
Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24 Command line :/usr/bin/fedora-review -b 2251482 Buildroot used: fedora-rawhide-x86_64 Active plugins: Shell-api, Generic, Python Disabled plugins: SugarActivity, Haskell, Perl, C/C++, Ocaml, Java, fonts, PHP, R Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH
The package is therefore APPROVED.
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
--- Comment #5 from Fedora Admin user for bugzilla script actions fedora-admin-xmlrpc@fedoraproject.org --- The Pagure repository was created at https://src.fedoraproject.org/rpms/fawltydeps
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
Fedora Update System updates@fedoraproject.org changed:
What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |MODIFIED
--- Comment #6 from Fedora Update System updates@fedoraproject.org --- FEDORA-2024-da202d8926 has been submitted as an update to Fedora 40. https://bodhi.fedoraproject.org/updates/FEDORA-2024-da202d8926
https://bugzilla.redhat.com/show_bug.cgi?id=2251482
Fedora Update System updates@fedoraproject.org changed:
What |Removed |Added ---------------------------------------------------------------------------- Status|MODIFIED |CLOSED Resolution|--- |ERRATA Last Closed| |2024-01-16 22:33:26
--- Comment #7 from Fedora Update System updates@fedoraproject.org --- FEDORA-2024-da202d8926 has been pushed to the Fedora 40 stable repository. If problem still persists, please make note of it in this bug report.
package-review@lists.fedoraproject.org
-
bugzilla＠redhat.com