Bug 2137747 - Review Request: python-puzpy - Python crossword puzzle library
Summary: Review Request: python-puzpy - Python crossword puzzle library
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Benson Muite
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 2137749
TreeView+ depends on / blocked
 
Reported: 2022-10-26 04:59 UTC by Davide Cavalca
Modified: 2022-11-10 22:26 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-10-26 18:26:26 UTC
Type: ---
Embargoed:
benson_muite: fedora-review+


Attachments (Terms of Use)

Description Davide Cavalca 2022-10-26 04:59:41 UTC
Spec URL: https://dcavalca.fedorapeople.org/review/python-puzpy/python-puzpy.spec
SRPM URL: https://dcavalca.fedorapeople.org/review/python-puzpy/python-puzpy-0.2.4-1.fc38.src.rpm

Description:
Implementation of .puz crossword puzzle file parser based on the .puz file
format documentation.

Fedora Account System Username: dcavalca

Comment 1 Davide Cavalca 2022-10-26 04:59:43 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=93454126

Comment 2 Benson Muite 2022-10-26 08:02:31 UTC
Package Review
==============

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



===== 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", "*No copyright* MIT
     License". 19 files have unknown license. Detailed output of
     licensecheck in /home/FedoraPackaging/reviews/python-puzpy/2137747-
     python-puzpy/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 2 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:
[-]: 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
[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.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: 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.
[-]: 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: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Cannot parse rpmlint output:


Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/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: 1

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



Source checksums
----------------
https://github.com/alexdej/puzpy/archive/v0.2.4/puzpy-0.2.4.tar.gz :
  CHECKSUM(SHA256) this package     : 9daa76988b6e82b1ff7b5ac1cfddf6ffc491d1779eb4e1a0677bb858c67e170e
  CHECKSUM(SHA256) upstream package : 9daa76988b6e82b1ff7b5ac1cfddf6ffc491d1779eb4e1a0677bb858c67e170e


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



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



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review -b 2137747
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api, Python
Disabled plugins: Haskell, PHP, C/C++, Ruby, fonts, SugarActivity, R, Perl, Java, Ocaml
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comments:
a) When running the tests get he following output:
+ /usr/bin/python3 -m tox --current-env -q --recreate -e py311
.........E.................
======================================================================
ERROR: test_v1_4 (__main__.PuzzleTests.test_v1_4)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/builddir/build/BUILD/puzpy-0.2.4/tests.py", line 77, in test_v1_4
    p = puz.read('testfiles/nyt_v1_4.puz')
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/builddir/build/BUILD/puzpy-0.2.4/puz.py", line 103, in read
    with open(filename, 'rb') as f:
         ^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'testfiles/nyt_v1_4.puz'
----------------------------------------------------------------------
Ran 27 tests in 0.256s
FAILED (errors=1)
/builddir/build/BUILD/puzpy-0.2.4/tests.py

The problem seems to be that the fixup commit adds an additional test which is available in the git repository, but the source file used in the test nyt_v1_4.puz is not available in the released sources. There is an issue which has been open for a while:
https://github.com/alexdej/puzpy/issues/27

Downloading the release from PyPi and doing a diff on puz.py gives the following:
$ diff puzpy-0.2.5/puz.py puzpy-0.2.4/puz.py 
9c9
< __version__ = '0.2.5'
---
> __version__ = '0.2.3'
285,287d284
<     def version_tuple(self):
<       return tuple(map(int, self.version.decode(ENCODING).split('.')))
< 
347c344
<         # termination, followed by notes (but only for version >= 1.3)
---
>         # termination, followed by notes (but only for version 1.3)
359,360c356,357
<         # notes included in global cksum starting v1.3 of format
<         if self.version_tuple() >= (1,3) and self.notes:
---
>         # notes included in global cksum only in v1.3 of format
>         if self.version.decode(ENCODING) == '1.3' and self.notes:


Maybe check with dependent packages to determine if the above changes are needed, and whether to add the additional test case file.

b) the license is installed twice at:
usr/lib/python3.11/site-packages/puzpy-0.2.4.dist-info/LICENSE
and
/usr/share/licenses/python3-puzpy/LICENSE
Probably the %license field in the spec file can be dropped and a softlink added? Maybe this needs clarification from Python SIG?

Comment 3 Davide Cavalca 2022-10-26 16:53:23 UTC
There's a comment on top of the specfile that attemps to explain the versioning mess here. As for %license, it's a known issue and I've hit that before with rust packages too.

Spec URL: https://dcavalca.fedorapeople.org/review/python-puzpy/python-puzpy.spec
SRPM URL: https://dcavalca.fedorapeople.org/review/python-puzpy/python-puzpy-0.2.4-1.fc38.src.rpm

Changelog:
- add missing test artifact
- fix %license usage

Comment 4 Benson Muite 2022-10-26 17:47:38 UTC
Thanks. All tests pass. 

In the spec file, you do not need the line
%license %{python3_sitelib}/%{srcname}-%{version}.dist-info/LICENSE
For Python packages, it is known that the LICENSE file is in dist-info, this is to match PyPi.
Please remove this line before importing.

Approved.

Comment 5 Benson Muite 2022-10-26 17:54:05 UTC
One other option for versioning is to add a git commit suffix, see for example:
https://jskarvad.fedorapeople.org/bCNC/bCNC.spec
but what you have done seems fine.

Comment 6 Davide Cavalca 2022-10-26 17:56:46 UTC
Thanks!

$ fedpkg request-repo python-puzpy 2137747
https://pagure.io/releng/fedora-scm-requests/issue/48436
$ fedpkg request-branch --repo python-puzpy f37
https://pagure.io/releng/fedora-scm-requests/issue/48437
$ fedpkg request-branch --repo python-puzpy f36
https://pagure.io/releng/fedora-scm-requests/issue/48438

Comment 7 Gwyn Ciesla 2022-10-26 18:15:41 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-puzpy

Comment 8 Fedora Update System 2022-10-26 18:23:40 UTC
FEDORA-2022-eb6204b3ff has been submitted as an update to Fedora 38. https://bodhi.fedoraproject.org/updates/FEDORA-2022-eb6204b3ff

Comment 9 Fedora Update System 2022-10-26 18:26:26 UTC
FEDORA-2022-eb6204b3ff has been pushed to the Fedora 38 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 10 Fedora Update System 2022-10-26 19:55:56 UTC
FEDORA-2022-eafdde82a1 has been submitted as an update to Fedora 37. https://bodhi.fedoraproject.org/updates/FEDORA-2022-eafdde82a1

Comment 11 Fedora Update System 2022-10-26 20:03:06 UTC
FEDORA-2022-15ebe840a5 has been submitted as an update to Fedora 36. https://bodhi.fedoraproject.org/updates/FEDORA-2022-15ebe840a5

Comment 12 Fedora Update System 2022-10-27 11:07:55 UTC
FEDORA-2022-eafdde82a1 has been pushed to the Fedora 37 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2022-eafdde82a1 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2022-eafdde82a1

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 13 Fedora Update System 2022-10-27 12:14:14 UTC
FEDORA-2022-15ebe840a5 has been pushed to the Fedora 36 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2022-15ebe840a5 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2022-15ebe840a5

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 14 Fedora Update System 2022-11-03 15:57:57 UTC
FEDORA-2022-15ebe840a5 has been pushed to the Fedora 36 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 15 Fedora Update System 2022-11-10 22:26:37 UTC
FEDORA-2022-eafdde82a1 has been pushed to the Fedora 37 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.