Bug 1862306 - Review Request: easyrpg-player - Game interpreter for RPG Maker 2000/2003 and EasyRPG games
Summary: Review Request: easyrpg-player - Game interpreter for RPG Maker 2000/2003 and...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Andy Mender
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 1862305
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-07-31 00:57 UTC by Artur Frenszek-Iwicki
Modified: 2020-08-19 01:01 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-08-19 00:51:39 UTC
Type: ---
Embargoed:
andymenderunix: fedora-review+


Attachments (Terms of Use)

Description Artur Frenszek-Iwicki 2020-07-31 00:57:32 UTC
spec: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-1/easyrpg-player.spec
srpm: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-1/easyrpg-player-0.6.2.1-1.fc32.src.rpm

Description: EasyRPG Player is a game interpreter for RPG Maker 2000/20003 and EasyRPG games.

Fedora Account System Username: suve

Comment 1 Artur Frenszek-Iwicki 2020-08-03 16:45:19 UTC
I took a better look at the sources and noticed some bundled libraries - added patches to un-bundle those.
Since liblcf has been approved recently, I also submitted a koji build. 

spec: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-2/easyrpg-player.spec
srpm: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-2/easyrpg-player-0.6.2.1-2.fc32.src.rpm
koji: https://koji.fedoraproject.org/koji/taskinfo?taskID=48526046

Comment 2 Andy Mender 2020-08-06 19:49:07 UTC
Since it would be a real shame if this didn't go into the repos, I'll review it :).

> # EasyRPG Player itself is GPLv3+.
> [...]
> # PicoJSON is used only for Emscripten builds (and unbundled before build).
> # Dirent is used only for MS Windows builds (and unbundled before build).
> License: GPLv3+ and BSD

Really good job with the license split!

> BuildRequires: fmt-devel
> BuildRequires: freetype-devel
> BuildRequires: liblcf-devel
> BuildRequires: libpng-devel
> BuildRequires: libsndfile-devel
> BuildRequires: libvorbis-devel
> BuildRequires: libxmp-devel
> BuildRequires: mpg123-devel
> BuildRequires: opusfile-devel
> BuildRequires: pixman-devel
> BuildRequires: SDL2-devel
> BuildRequires: SDL2_mixer-devel
> BuildRequires: speexdsp-devel
> BuildRequires: wildmidi-devel
> BuildRequires: zlib-devel

I would check whether it's not possible to rely on pkgconfig for some of these, replacing "foo-devel" with "pkgconfig(foo)". For packages which do not provide pkgconfig files one can still use "foo-devel".

> # The upstream CMakeLists.txt forgets to install this file.
> install -m 755 -d %{buildroot}%{_libdir}/
> install -m 755 -p "%{__cmake_builddir}/libEasyRPG_Player.so" %{buildroot}%{_libdir}/

The shared lib should probably be versioned since this is not a -devel package.

Other than that, everything's nice and clean. Complete review matrix below:

Package Review
==============

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


Issues:
=======
- Development (unversioned) .so files in -devel subpackage, if present.
  Note: Unversioned so-files directly in %_libdir.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/#_devel_packages
  Review: mentioned in an earlier comment


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

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Header files in -devel subpackage, if present.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
     Review: Koji build provided by the submitter
[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", "*No copyright* Expat
     License", "*No copyright* GPL (v3 or later)", "BSD 3-clause "New" or
     "Revised" License", "BSD 2-clause "Simplified" License", "GPL (v3 or
     later)", "FSF All Permissive License", "Boost Software License 1.0",
     "GNU Lesser General Public License", "GNU Free Documentation License
     (v1.2 or later)". 387 files have unknown license. Detailed output of
     licensecheck in /home/amender/rpmbuild/SPECS/easyrpg-player/easyrpg-
     player/licensecheck.txt
     Review: ran licensecheck manually. The Boost-licensed file is a development 
     file not included in the package:
     builds/cmake/Modules/FindSDL2.cmake: Boost Software License 1.0
[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
[?]: 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.
[?]: 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 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]: 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:
[x]: Reviewer should test that the package builds in mock.
[-]: 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.
     Review: Yes, the latest patch release.
[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]: 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.
     Review: Koji build provided by the submitter.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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]: Fully versioned dependency in subpackages if applicable.
[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 debuginfo package(s).
     Note: No rpmlint messages.
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.


Rpmlint
-------
Checking: easyrpg-player-0.6.2.1-2.fc33.x86_64.rpm
          easyrpg-player-debuginfo-0.6.2.1-2.fc33.x86_64.rpm
          easyrpg-player-debugsource-0.6.2.1-2.fc33.x86_64.rpm
          easyrpg-player-0.6.2.1-2.fc33.src.rpm
easyrpg-player.x86_64: E: invalid-soname /usr/lib64/libEasyRPG_Player.so libEasyRPG_Player.so
easyrpg-player.x86_64: W: shared-lib-calls-exit /usr/lib64/libEasyRPG_Player.so exit.5
4 packages and 0 specfiles checked; 1 errors, 1 warnings.




Rpmlint (debuginfo)
-------------------
Checking: easyrpg-player-debuginfo-0.6.2.1-2.fc33.x86_64.rpm
1 packages and 0 specfiles checked; 0 errors, 0 warnings.





Rpmlint (installed packages)
----------------------------
(none): E: no installed packages by name easyrpg-player-debugsource
(none): E: no installed packages by name easyrpg-player
(none): E: no installed packages by name easyrpg-player-debuginfo
0 packages and 0 specfiles checked; 0 errors, 0 warnings.



Unversioned so-files
--------------------
easyrpg-player: /usr/lib64/libEasyRPG_Player.so

Source checksums
----------------
https://github.com/EasyRPG/Player/archive/0.6.2.1/Player-0.6.2.1.tar.gz :
  CHECKSUM(SHA256) this package     : 59ffaff8da684b3cc391ac7bff5b95ddab524896cfb732cc2a8ff193bbbec8ac
  CHECKSUM(SHA256) upstream package : 59ffaff8da684b3cc391ac7bff5b95ddab524896cfb732cc2a8ff193bbbec8ac


Requires
--------
easyrpg-player (rpmlib, GLIBC filtered):
    libEasyRPG_Player.so()(64bit)
    libSDL2-2.0.so.0()(64bit)
    libSDL2_mixer-2.0.so.0()(64bit)
    libWildMidi.so.2()(64bit)
    libc.so.6()(64bit)
    libfreetype.so.6()(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgcc_s.so.1(GCC_3.3.1)(64bit)
    liblcf.so.0()(64bit)
    libm.so.6()(64bit)
    libmpg123.so.0()(64bit)
    libopusfile.so.0()(64bit)
    libpixman-1.so.0()(64bit)
    libpng16.so.16()(64bit)
    libpng16.so.16(PNG16_0)(64bit)
    libpthread.so.0()(64bit)
    libsndfile.so.1()(64bit)
    libsndfile.so.1(libsndfile.so.1.0)(64bit)
    libspeexdsp.so.1()(64bit)
    libstdc++.so.6()(64bit)
    libstdc++.so.6(CXXABI_1.3)(64bit)
    libstdc++.so.6(CXXABI_1.3.2)(64bit)
    libstdc++.so.6(CXXABI_1.3.5)(64bit)
    libstdc++.so.6(CXXABI_1.3.9)(64bit)
    libvorbisfile.so.3()(64bit)
    libxmp.so.4()(64bit)
    libxmp.so.4(XMP_4.0)(64bit)
    libxmp.so.4(XMP_4.1)(64bit)
    libxmp.so.4(XMP_4.3)(64bit)
    libxmp.so.4(XMP_4.4)(64bit)
    libz.so.1()(64bit)
    rtld(GNU_HASH)

easyrpg-player-debuginfo (rpmlib, GLIBC filtered):

easyrpg-player-debugsource (rpmlib, GLIBC filtered):



Provides
--------
easyrpg-player:
    easyrpg-player
    easyrpg-player(x86-64)
    libEasyRPG_Player.so()(64bit)

easyrpg-player-debuginfo:
    debuginfo(build-id)
    easyrpg-player-debuginfo
    easyrpg-player-debuginfo(x86-64)

easyrpg-player-debugsource:
    easyrpg-player-debugsource
    easyrpg-player-debugsource(x86-64)

Comment 3 Artur Frenszek-Iwicki 2020-08-07 10:47:28 UTC
>I would check whether it's not possible to rely on pkgconfig for some of these, replacing "foo-devel" with "pkgconfig(foo)". For packages which do not provide pkgconfig files one can still use "foo-devel".
I haven't used pkgconfig for packaging so far, but I checked and it seems all of the dependencies provide pkgconfig files, so I switched them all.

>The shared lib should probably be versioned since this is not a -devel package.
I'm not too versed in CMake, but the impression I got from reading the CMakeLists.txt is that it builds a dynamic library containing most of the logic, whereas the "easyrpg-player" executable and the test runners are just thin wrappers around the lib. I modified the CMakeLists to build a static library instead. Both the player and the tests seem to run fine, and it gets rid of the .so file.

spec: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-3/easyrpg-player.spec
srpm: https://svgames.pl/fedora/easyrpg-player-0.6.2.1-3/easyrpg-player-0.6.2.1-3.fc32.src.rpm
koji: https://koji.fedoraproject.org/koji/taskinfo?taskID=48868685

Comment 4 Andy Mender 2020-08-07 18:07:35 UTC
> I'm not too versed in CMake, but the impression I got from reading the CMakeLists.txt is that it builds a dynamic library containing most of the logic, whereas the "easyrpg-player" executable and the test runners are just thin wrappers around the lib. I modified the CMakeLists to build a static library instead. Both the player and the tests seem to run fine, and it gets rid of the .so file.

Yes, that was also my impression, but that is completely okay - we want a shared library. According to the packaging guidelines, packaging static libraries should be avoided if possible: https://docs.fedoraproject.org/en-US/packaging-guidelines/#packaging-static-libraries

What you can do is kindly ask upstream to version their libEasyRPG_Player shared lib. This is done by setting the VERSION and SOVERSION properties of the EasyRPG_player target (added via add_library in this CMakeLists file: https://github.com/EasyRPG/Player/blob/master/CMakeLists.txt).
set_target_property(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION})
set_target_property(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR})

Short-term, you can either hack it into the SPEC file or better yet, create a patch against the CMakeLists file in question which could be a part of the fix to upstream. Since it's only 2 isolated lines, it shouldn't interfere with the flow of the CMakeLists file.

If you want to force the lib to be a shared one, you can use this cmake flag:
-DBUILD_SHARED_LIBS=ON

Comment 5 Artur Frenszek-Iwicki 2020-08-07 18:33:19 UTC
I think using static linking has more sense here, since we don't ship a -devel package and don't really expect to have other packages linking to libEasyRPG_Player. The "easyrpg-player" executable isn't built 100% static; only the libEasyRPG_Player is linked static. 

Regarding the packaging guidelines, I think this bit is of most interest here:
> Executables and libraries SHOULD NOT be linked statically against libraries which come from other packages. (It is of course acceptable for files generated during a package’s build process to be linked statically against .a files generated as part of that build process.)
The "easyrpg-player" uses dynamic linking for everything, apart from libEasyRPG_Player. Given what I said above about not shipping any -devel files, I think static linking against libEasyRPG_Player is fine here.

Comment 6 Andy Mender 2020-08-08 16:45:41 UTC
> I think using static linking has more sense here, since we don't ship a -devel package and don't really expect to have other packages linking to libEasyRPG_Player. The "easyrpg-player" executable isn't built 100% static; only the libEasyRPG_Player is linked static.

If this is the case and libEasyRPG_Player is more of an internal library for the easyrpg-player binary, I agree it's okay.

Package approved!

Comment 7 Igor Raits 2020-08-09 10:54:16 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/easyrpg-player

Comment 8 Fedora Update System 2020-08-10 14:55:49 UTC
FEDORA-2020-d6ea20d3da has been submitted as an update to Fedora 32. https://bodhi.fedoraproject.org/updates/FEDORA-2020-d6ea20d3da

Comment 9 Fedora Update System 2020-08-10 14:57:20 UTC
FEDORA-2020-e208cf4e22 has been submitted as an update to Fedora 31. https://bodhi.fedoraproject.org/updates/FEDORA-2020-e208cf4e22

Comment 10 Fedora Update System 2020-08-11 14:04:42 UTC
FEDORA-2020-e208cf4e22 has been pushed to the Fedora 31 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-e208cf4e22 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-e208cf4e22

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

Comment 11 Fedora Update System 2020-08-11 14:28:20 UTC
FEDORA-2020-d6ea20d3da has been pushed to the Fedora 32 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-d6ea20d3da \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-d6ea20d3da

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

Comment 12 Fedora Update System 2020-08-19 00:51:39 UTC
FEDORA-2020-d6ea20d3da has been pushed to the Fedora 32 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 13 Fedora Update System 2020-08-19 01:01:33 UTC
FEDORA-2020-e208cf4e22 has been pushed to the Fedora 31 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.