Bug 2165410 - Review Request: Catch2 - A modern, C++-native, test framework for unit-tests, TDD and BDD
Summary: Review Request: Catch2 - A modern, C++-native, test framework for unit-tests,...
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Sandro Mani
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-01-29 22:51 UTC by Benson Muite
Modified: 2023-03-07 07:20 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-03-07 07:20:51 UTC
Type: Bug
Embargoed:
manisandro: fedora-review+


Attachments (Terms of Use)
The .spec file difference from Copr build 5356862 to 5364318 (1.28 KB, patch)
2023-01-30 14:42 UTC, Jakub Kadlčík
no flags Details | Diff

Description Benson Muite 2023-01-29 22:51:04 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/fed500/Catch2/fedora-rawhide-x86_64/05356568-Catch2/Catch2.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/fed500/Catch2/fedora-rawhide-x86_64/05356568-Catch2/Catch2-3.3.0-1.src.rpm

Description:
Catch2 is mainly a unit testing framework for C++, but it also provides basic
micro-benchmarking features, and simple BDD macros.

Fedora Account System Username: fed500

Comment 1 Jakub Kadlčík 2023-01-29 22:57:47 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5356862
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2165410-Catch2/fedora-rawhide-x86_64/05356862-Catch2/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

Comment 2 Sandro Mani 2023-01-30 08:45:15 UTC
Some initial comments:

- I'd suggest using

      Source0:        %{url}/archive/refs/tags/v%{version}/%{name}-%{version}.tar.gz

  to have the source archive filename not just be a version.

- Unowned directories: %{_datadir}/%{name}/, %{_includedir}/catch2/, either add

      %dir %{_datadir}/%{name}
      %dir %{_includedir}/catch2

  or list the these as 

      %{_datadir}/%{name}/
      %{_includedir}/catch2/

- Group should not be used: https://docs.fedoraproject.org/en-US/packaging-guidelines/#_tags_and_sections

Comment 4 Jakub Kadlčík 2023-01-30 14:42:49 UTC
Created attachment 1941098 [details]
The .spec file difference from Copr build 5356862 to 5364318

Comment 5 Jakub Kadlčík 2023-01-30 14:42:52 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5364318
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2165410-Catch2/fedora-rawhide-x86_64/05364318-Catch2/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

Comment 6 Sandro Mani 2023-01-31 06:36:50 UTC
Issues:
- Missing %{?dist} tag in release
- %{_includedir}/catch2/ unowned -> Add %dir %{_includedir}/catch2 or write %{_includedir}/catch2/
- %{_libdir}/cmake/%{name}/ unowned -> Add %dir %{_libdir}/cmake/%{name} or write %{_libdir}/cmake/%{name}/
- rpmlint: W: incoherent-version-in-changelog 3.2.2-1 ['3.3.0-1', '3.3.0-1']

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

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


Issues:
=======
- Dist tag is present.


===== 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]: ldconfig not called in %post and %postun for Fedora 28 and later.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.
[x]: Development (unversioned) .so files in -devel subpackage, if present.

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* Boost Software License
     1.0", "Boost Software License 1.0", "*No copyright* Boost Software
     License", "*No copyright* GNU General Public License, Version 3". 144
     files have unknown license.
[x]: License file installed when any subpackage combination is installed.
[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/include/catch2/matchers,
     /usr/include/catch2/generators, /usr/include/catch2/internal,
     /usr/include/catch2/benchmark/detail, /usr/include/catch2/benchmark,
     /usr/include/catch2/matchers/internal, /usr/include/catch2/interfaces,
     /usr/include/catch2/reporters
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/include/catch2/matchers,
     /usr/include/catch2/generators, /usr/include/catch2/matchers/internal,
     /usr/lib64/cmake/Catch2, /usr/include/catch2/benchmark,
     /usr/include/catch2/interfaces, /usr/include/catch2/internal,
     /usr/include/catch2/benchmark/detail, /usr/include/catch2/reporters
[x]: Package does not own files or directories owned by other packages.
[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]: Useful -debuginfo package or justification otherwise.
[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 348160 bytes in 35 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 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

===== 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.
[?]: 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.
[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]: Fully versioned dependency in subpackages if applicable.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: The placement of pkgconfig(.pc) files are correct.
[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: There are rpmlint messages (see attachment).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: Catch2-3.3.0-1.x86_64.rpm
          Catch2-devel-3.3.0-1.x86_64.rpm
          Catch2-debuginfo-3.3.0-1.x86_64.rpm
          Catch2-debugsource-3.3.0-1.x86_64.rpm
          Catch2-3.3.0-1.src.rpm
================================================================== 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
rpmlintrc: [PosixPath('/tmp/tmpiy3utfq9')]
checks: 31, packages: 5

Catch2-devel.x86_64: W: no-documentation
Catch2.x86_64: W: incoherent-version-in-changelog 3.2.2-1 ['3.3.0-1', '3.3.0-1']
=================================== 5 packages and 0 specfiles checked; 0 errors, 2 warnings, 0 badness; has taken 0.9 s ===================================




Rpmlint (debuginfo)
-------------------
Checking: Catch2-debuginfo-3.3.0-1.x86_64.rpm
================================================================== 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
rpmlintrc: [PosixPath('/tmp/tmpbtq3bzp2')]
checks: 31, packages: 1

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





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: 4

Catch2-devel.x86_64: W: no-documentation
Catch2.x86_64: W: incoherent-version-in-changelog 3.2.2-1 ['3.3.0-1', '3.3.0-1']
 4 packages and 0 specfiles checked; 0 errors, 2 warnings, 0 badness; has taken 0.8 s 



Source checksums
----------------
https://github.com/catchorg/Catch2/archive/refs/tags/v3.3.0/Catch2-3.3.0.tar.gz :
  CHECKSUM(SHA256) this package     : fe2f29a54ca775c2dd04bb97ffb79d398e6210e3caa174348b5cd3b7e4ca887d
  CHECKSUM(SHA256) upstream package : 48f06c98e685ac809db092364a7ef5604ed51f3e9edacca1b4beb84cdd147038
However, diff -r shows no differences


Requires
--------
Catch2 (rpmlib, GLIBC filtered):
    cmake-filesystem(x86-64)
    libCatch2.so.3.3.0()(64bit)
    libc.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)
    libm.so.6()(64bit)
    libstdc++.so.6()(64bit)
    libstdc++.so.6(CXXABI_1.3)(64bit)
    libstdc++.so.6(CXXABI_1.3.13)(64bit)
    libstdc++.so.6(CXXABI_1.3.3)(64bit)
    libstdc++.so.6(CXXABI_1.3.9)(64bit)
    rtld(GNU_HASH)

Catch2-devel (rpmlib, GLIBC filtered):
    /usr/bin/pkg-config
    Catch2(x86-64)
    libCatch2.so.3.3.0()(64bit)
    libCatch2Main.so.3.3.0()(64bit)
    pkgconfig(catch2)

Catch2-debuginfo (rpmlib, GLIBC filtered):

Catch2-debugsource (rpmlib, GLIBC filtered):



Provides
--------
Catch2:
    Catch2
    Catch2(x86-64)
    cmake(Catch2)
    cmake(catch2)
    libCatch2.so.3.3.0()(64bit)
    libCatch2Main.so.3.3.0()(64bit)

Catch2-devel:
    Catch2-devel
    Catch2-devel(x86-64)
    pkgconfig(catch2)
    pkgconfig(catch2-with-main)

Catch2-debuginfo:
    Catch2-debuginfo
    Catch2-debuginfo(x86-64)
    debuginfo(build-id)
    libCatch2.so.3.3.0-3.3.0-1.x86_64.debug()(64bit)
    libCatch2Main.so.3.3.0-3.3.0-1.x86_64.debug()(64bit)

Catch2-debugsource:
    Catch2-debugsource
    Catch2-debugsource(x86-64)



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

Comment 8 Sandro Mani 2023-01-31 17:47:31 UTC
Approved - I'd just suggest simplifying 

%dir %{_includedir}/catch2
%{_includedir}/catch2/*.hpp
%dir %{_includedir}/catch2/benchmark
%{_includedir}/catch2/benchmark/*.hpp
%dir %{_includedir}/catch2/benchmark/detail
%{_includedir}/catch2/benchmark/detail/*.hpp
%dir %{_includedir}/catch2/generators
%{_includedir}/catch2/generators/*.hpp
%dir %{_includedir}/catch2/interfaces
%{_includedir}/catch2/interfaces/*.hpp
%dir %{_includedir}/catch2/internal
%{_includedir}/catch2/internal/*.hpp
%dir %{_includedir}/catch2/matchers
%{_includedir}/catch2/matchers/*.hpp
%dir %{_includedir}/catch2/matchers/internal
%{_includedir}/catch2/matchers/internal/*.hpp
%dir %{_includedir}/catch2/reporters
%{_includedir}/catch2/reporters/*.hpp

to just

%{_includedir}/catch2/

for better readability.

Comment 9 Fedora Admin user for bugzilla script actions 2023-01-31 18:06:53 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/Catch2

Comment 10 Benson Muite 2023-01-31 18:10:54 UTC
Thanks. If ok, prefer the long form as it allows me to know what is included more easily, though it is a bit harder to read.

Comment 11 Neal Gompa 2023-02-01 01:11:26 UTC
This package was already in Fedora as catch: https://src.fedoraproject.org/rpms/catch

Comment 12 Benson Muite 2023-02-01 08:50:47 UTC
Ok. Retired it. Thanks for the review Sandro and the information about Catch Neal.

Created a pull request to update Catch
https://src.fedoraproject.org/rpms/catch/pull-request/5


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