Bug 1827784

Summary: Review Request: python-jsonrpc-server - JSON RPC 2.0 server library
Product: [Fedora] Fedora Reporter: Mukundan Ragavan <nonamedotc>
Component: Package ReviewAssignee: Lumír Balhar <lbalhar>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: lbalhar, package-review
Target Milestone: ---Flags: lbalhar: fedora-review+
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-04-27 18:39:40 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Comment 1 Lumír Balhar 2020-04-26 06:15:33 UTC
Hello.

A quick check with rpmlint says:

Checking: python3-jsonrpc-server-0.3.4-1.fc33.noarch.rpm
          python-jsonrpc-server-0.3.4-1.fc33.src.rpm
python3-jsonrpc-server.noarch: W: unexpanded-macro %description -l C %_description
python3-jsonrpc-server.noarch: W: description-shorter-than-summary
python3-jsonrpc-server.noarch: W: invalid-license None
python3-jsonrpc-server.noarch: E: useless-provides python-jsonrpc-server
python3-jsonrpc-server.noarch: E: useless-provides python38-jsonrpc-server
python-jsonrpc-server.src: W: unexpanded-macro %description -l C %_description
python-jsonrpc-server.src: W: description-shorter-than-summary
python-jsonrpc-server.src: W: invalid-license None
2 packages and 0 specfiles checked; 2 errors, 6 warnings.

Also, it would be nice to describe in a comment, why the three tests are deselected. It seems (from the OpenSUSE specfile), that those tests aren't compatible with Python 3.8: https://github.com/palantir/python-jsonrpc-server/issues/33

Comment 2 Mukundan Ragavan 2020-04-26 13:17:26 UTC
I have addressed all of  these except - 

python3-jsonrpc-server.noarch: E: useless-provides python-jsonrpc-server
python3-jsonrpc-server.noarch: E: useless-provides python38-jsonrpc-server


To get rid of this, I will need to remove %python_provide macro.

$ rpmlint python-jsonrpc-server.spec /var/lib/mock/fedora-rawhide-x86_64/result/python3-jsonrpc-server-0.3.4-2.fc33.noarch.rpm ~/rpmbuild/SRPMS/python-jsonrpc-server-0.3.4-2.fc32.src.rpm 
2 packages and 1 specfiles checked; 0 errors, 0 warnings.


$ rpm -qp --provides /var/lib/mock/fedora-rawhide-x86_64/result/python3-jsonrpc-server-0.3.4-2.fc33.noarch.rpm
python-jsonrpc-server = 0.3.4-2.fc33
python3-jsonrpc-server = 0.3.4-2.fc33
python3.8dist(python-jsonrpc-server) = 0.3.4
python38-jsonrpc-server = 0.3.4-2.fc33
python3dist(python-jsonrpc-server) = 0.3.4



I don't think I should remove the macro though since it is required to be included for python packages [1].

[1] https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_provides



Updated SPEC URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/2019-2020/jsonrpc-server/python-jsonrpc-server.spec
Updated SRPM URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/2019-2020/jsonrpc-server/python-jsonrpc-server-0.3.4-2.fc32.src.rpm

Comment 3 Lumír Balhar 2020-04-26 15:28:52 UTC
> I don't think I should remove the macro though since it is required to be
> included for python packages [1].

You are right. The solution here depends on what versions of Fedora you want to create this package for. F33+ has this provides automatically generated so rpmlint complains about duplicities but if you remove it you lose some provides on F32. So, if you want to have this package for F32, keep the macro there and we'll ignore the warning.

I'll hopefully finish this review today.

Comment 4 Lumír Balhar 2020-04-26 17:09:22 UTC
Ok, we are almost done here. The last problem I see is that the package is not installable. The problem comes from setup.py where the dependency on ujson is defined with the limit "<=1.35" which then leads to automatically generated "Requires: python3.8dist(ujson) <= 1.35".

However, there is ujson 2.0.0 installed during the build and all tests are passing so it should work correctly. I've mentioned this fact in https://github.com/palantir/python-jsonrpc-server/issues/36 From the source code, it seems, that this module should also work with json module from Python stdlib (because ujson is disabled on Windows).

You have two possibilities here:
* remove the limit "<=1.35" in setup.py (by sed) and hope that it'll work with the newer ujson, or
* remove the runtime dependency entirely (from the setup.py and from the specfile) and let it use json from stdlib

A side-note: Package reviewers use a tool called fedora-review which can do a lot of testing for you so you might be able to discover a lot of problems before you open a review request. But you don't have to, of course. I personally prefer to review my own package before I open a review request because it can lower the amount of ping-pong :)

Comment 5 Mukundan Ragavan 2020-04-26 18:53:07 UTC
(In reply to Lumír Balhar from comment #4)
> Ok, we are almost done here. The last problem I see is that the package is
> not installable. The problem comes from setup.py where the dependency on
> ujson is defined with the limit "<=1.35" which then leads to automatically
> generated "Requires: python3.8dist(ujson) <= 1.35".
> 
> However, there is ujson 2.0.0 installed during the build and all tests are
> passing so it should work correctly. I've mentioned this fact in
> https://github.com/palantir/python-jsonrpc-server/issues/36 From the source
> code, it seems, that this module should also work with json module from
> Python stdlib (because ujson is disabled on Windows).
> 
> You have two possibilities here:
> * remove the limit "<=1.35" in setup.py (by sed) and hope that it'll work
> with the newer ujson, or

I meant to do this when I saw that tests didn't fail. I have removed the ujson version limit now.

> 
> A side-note: Package reviewers use a tool called fedora-review which can do
> a lot of testing for you so you might be able to discover a lot of problems
> before you open a review request. But you don't have to, of course. I
> personally prefer to review my own package before I open a review request
> because it can lower the amount of ping-pong :)


I typically run fedora-review as well although I admit I did not run for these two packages (this and lang server). Apologies.

That said, here is the updated spec and SRPM that fixes issues.


Updated SPEC URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/2019-2020/jsonrpc-server/python-jsonrpc-server.spec
Updated SRPM URL: https://nonamedotc.fedorapeople.org/pkgreview/python-packages/2019-2020/jsonrpc-server/python-jsonrpc-server-0.3.4-3.fc32.src.rpm

Comment 6 Lumír Balhar 2020-04-27 05:14:46 UTC
Good job. The package is approved!

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", "Expat License". 20 files have unknown
     license. Detailed output of licensecheck in
     /home/lbalhar/temp/reviews/1827784-python-jsonrpc-
     server/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 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.
[-]: 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).
[x]: 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.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[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:
[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: python3-jsonrpc-server-0.3.4-3.fc33.noarch.rpm
          python-jsonrpc-server-0.3.4-3.fc33.src.rpm
python3-jsonrpc-server.noarch: E: useless-provides python-jsonrpc-server
python3-jsonrpc-server.noarch: E: useless-provides python38-jsonrpc-server
2 packages and 0 specfiles checked; 2 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
python3-jsonrpc-server.noarch: W: invalid-url URL: https://github.com/palantir/python-jsonrpc-server <urlopen error [Errno -2] Name or service not known>
python3-jsonrpc-server.noarch: E: useless-provides python-jsonrpc-server
python3-jsonrpc-server.noarch: E: useless-provides python38-jsonrpc-server
1 packages and 0 specfiles checked; 2 errors, 1 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/p/python-jsonrpc-server/python-jsonrpc-server-0.3.4.tar.gz :
  CHECKSUM(SHA256) this package     : c73bf5495c9dd4d2f902755bedeb6da5afe778e0beee82f0e195c4655352fe37
  CHECKSUM(SHA256) upstream package : c73bf5495c9dd4d2f902755bedeb6da5afe778e0beee82f0e195c4655352fe37


Requires
--------
python3-jsonrpc-server (rpmlib, GLIBC filtered):
    python(abi)
    python3.8dist(ujson)
    python3dist(ujson)



Provides
--------
python3-jsonrpc-server:
    python-jsonrpc-server
    python3-jsonrpc-server
    python3.8dist(python-jsonrpc-server)
    python38-jsonrpc-server
    python3dist(python-jsonrpc-server)

Comment 7 Gwyn Ciesla 2020-04-27 14:28:25 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-jsonrpc-server

Comment 8 Mukundan Ragavan 2020-04-27 18:39:40 UTC
Thanks for the review. I have built this package on rawhide and F32.