Bug 2134387
| Summary: | Review Request: mrack - Multicloud provisioner | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Tibor Dudlák <tdudlak> |
| Component: | Package Review | Assignee: | Jakub Kadlčík <jkadlcik> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | rawhide | CC: | package-review, praiskup |
| Target Milestone: | --- | Flags: | jkadlcik:
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: | 2023-10-08 08:14:16 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: | |||
| Bug Depends On: | |||
| Bug Blocks: | 177841 | ||
|
Description
Tibor Dudlák
2022-10-13 10:24:17 UTC
Hello Tibor, thank you for the package. Overall a very good spec file, but there are a few things that need to be fixed. > License: Apache License 2.0 The license is correct but it should be written differently. If you take a look at the allowed licenses documentation page https://docs.fedoraproject.org/en-US/legal/allowed-licenses/ and search for "apache" licenses, you can find "Apache Software License 2.0". In the past, we used to write the Fedora Abbreviation value (e.g. ASL 2.0) into the License field. Now we are moving towards the SPDX expression, so there should be Apache-2.0 in your License field. > Source0: https://github.com/neoave/mrack/releases/download/v%{version}/%{name}-%{version}.tar.gz Not necessary, only a tip. You can use ${URL}/releases/download/v%{version}/%{name}-%{version}.tar.gz it's shorter :-) > %description > mrack is a provisioning tool and a library for CI and local multi-host testing supporting > multiple provisioning providers (e.g. AWS, Beaker, Openstack). But in comparison to other > multi-cloud libraries, the aim is to be able to describe host from application perspective. According to the packaging guidelines, a description shouldn't be any longer than 80 characters per line. https://docs.fedoraproject.org/en-US/packaging-guidelines/#_summary_and_description Can you please re-wrap the lines? > %description cli > %{name}-cli contains mrack command which functionality can be extended by installing mrack plugins Same thing for the subpackages' descriptions > Summary: Multicloud use-case based multihost async provisioner for CIs and testing during development I think the 80 chars rule doesn't apply for a summary but if possible, I would try to stick to it anyway. Summary is usually displayed next to the package name (e.g. in dnf search) and we ideally want to display the information even in smaller terminal windows. > Requires: %{name}-cli == %{version}-%{release} AFAIK there should be only one equal sign. Or at least I haven't seen == before. > %doc README.md I think it would be worth it to provide CHANGELOG.md as well. > mrack-cli.noarch: W: no-manual-page-for-binary mrack This is not a blocker but it would be nice to have a manpage. I am not sure if there is a manpage in the upstream project or a way to generate it but if not, can you please submit an RFE for it and link it in the spec file, so we can easily track it and eventually install it? Hello Jakub, Thanks for the review it is much appreciated. Let me handle the requests upstream I will update this BZ accordingly with updated SRPMs and spec pointing to upstream. How should the RFE link in specfile should look like please? The RFE issue for the manpage in upstream: https://github.com/neoave/mrack/issues/197 Updated package and spec Spec URL: https://raw.githubusercontent.com/neoave/mrack/main/mrack.spec SRPM URL: https://download.copr.fedorainfracloud.org/results/@freeipa/neoave/fedora-37-x86_64/04962039-mrack/mrack-1.9.1-1.fc37.src.rpm Description: Multicloud use-case based multihost async provisioner for CIs and testing during development Copr: https://download.copr.fedorainfracloud.org/results/@freeipa/neoave/fedora-37-x86_64/04962039-mrack/ Fedora Account System Username: tdudlak Thank you very much for the changes.
I found one last thing
> mrack.noarch: W: unexpanded-macro %description -l C %python_provide
Every time I saw the python_provide line, it was under the python3
subpackage, so I think it needs to be there.
Actually, since we have multiple python3 subpackages here, I think it
should go to each one of them, e.g.
%package -n python3-%{name}lib
...
%{?python_provide:%python_provide python3-%{name}lib}
%package -n python3-%{name}-aws
...
%{?python_provide:%python_provide python3-%{name}-aws}
and so on.
Hmm, maybe a couple more fixes are needed > Summary: mrack command > mrack-cli.noarch: W: summary-not-capitalized mrack command So it should be "Mrack command", or maybe a bit better "Command line interface for Mrack". > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/osapi.cpython-311.opt-1.pyc > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/osapi.cpython-311.pyc > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/podman.cpython-311.opt-1.pyc > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/podman.cpython-311.pyc > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/testcloud.cpython-311.opt-1.pyc > python3-mracklib.noarch: W: python-bytecode-without-source /usr/lib/python3.11/site-packages/mrack/providers/utils/__pycache__/testcloud.cpython-311.pyc Check this out, e.g. for the podman file: The utils/podman.py file is installed by the python3-mrack-podman package. [root@90b766ba9afa /]# rpm -ql python3-mrack-podman |grep utils /usr/lib/python3.10/site-packages/mrack/providers/utils/podman.py But the pyc file is installed by python3-mracklib file [root@90b766ba9afa /]# rpm -ql python3-mracklib |grep podman /usr/lib/python3.10/site-packages/mrack/providers/utils/__pycache__/podman.cpython-310.opt-1.pyc /usr/lib/python3.10/site-packages/mrack/providers/utils/__pycache__/podman.cpython-310.pyc Updated package and spec Spec URL: https://raw.githubusercontent.com/neoave/mrack/main/mrack.spec SRPM URL: https://download.copr.fedorainfracloud.org/results/@freeipa/neoave/fedora-37-x86_64/04992205-mrack/mrack-1.10.0-1.fc37.src.rpm Description: Multicloud use-case based multihost async provisioner for CIs and testing during development Copr: https://download.copr.fedorainfracloud.org/results/@freeipa/neoave/fedora-37-x86_64/04992205-mrack/ Fedora Account System Username: tdudlak Thank you for the changes.
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", "*No copyright* Apache License 2.0",
"Apache License 2.0". 15 files have unknown license. Detailed output
of licensecheck in /home/jkadlcik/2134387-mrack/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[x]: Macros in Summary, %description expandable at SRPM build time.
Note: Macros in: mrack (description)
Note: I am aware of this, we are going to fix this post-review
[-]: 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 122880 bytes in 6 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]: 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:
[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:
[x]: 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).
[!]: Fully versioned dependency in subpackages if applicable.
Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in mrack-
cli , python3-mracklib , python3-mrack-aws , python3-mrack-beaker ,
python3-mrack-openstack , python3-mrack-podman , python3-mrack-virt
Note: We will fix this post-review
[?]: 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.
[?]: 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: There are rpmlint messages (see attachment).
[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: 8
mrack.noarch: W: unexpanded-macro %description -l C %python_provide
mrack-cli.noarch: W: no-manual-page-for-binary mrack
python3-mrack-virt.noarch: W: no-documentation
python3-mrack-aws.noarch: W: no-documentation
python3-mrack-podman.noarch: W: no-documentation
python3-mrack-openstack.noarch: W: no-documentation
python3-mrack-beaker.noarch: W: no-documentation
8 packages and 0 specfiles checked; 0 errors, 7 warnings, 0 badness; has taken 0.1 s
Source checksums
----------------
https://github.com/neoave/mrack/releases/download/v1.10.0/mrack-1.10.0.tar.gz :
CHECKSUM(SHA256) this package : 6ebdb9d00400d576b5c18c9a4766ae543beff6d8ede304859ac64ccffb1e4c76
CHECKSUM(SHA256) upstream package : 6ebdb9d00400d576b5c18c9a4766ae543beff6d8ede304859ac64ccffb1e4c76
Requires
--------
mrack (rpmlib, GLIBC filtered):
mrack-cli
python3-mrack-aws
python3-mrack-beaker
python3-mrack-openstack
python3-mrack-podman
python3-mrack-virt
python3-mracklib
mrack-cli (rpmlib, GLIBC filtered):
/usr/bin/python3
python3-mracklib
python3-mracklib (rpmlib, GLIBC filtered):
python(abi)
python3-click
python3-pyyaml
python3.11dist(beaker-client)
python3.11dist(boto3)
python3.11dist(botocore)
python3.11dist(click)
python3.11dist(pyyaml)
python3.11dist(testcloud)
sshpass
python3-mrack-aws (rpmlib, GLIBC filtered):
python(abi)
python3-boto3
python3-botocore
python3-mracklib
python3-mrack-beaker (rpmlib, GLIBC filtered):
beaker-client
python(abi)
python3-mracklib
python3-mrack-openstack (rpmlib, GLIBC filtered):
python(abi)
python3-mracklib
python3-mrack-podman (rpmlib, GLIBC filtered):
podman
python(abi)
python3-mracklib
python3-mrack-virt (rpmlib, GLIBC filtered):
python(abi)
python3-mracklib
testcloud
Provides
--------
mrack:
mrack
mrack-cli:
mrack-cli
python3-mracklib:
python-mracklib
python3-mracklib
python3.11-mracklib
python3.11dist(mrack)
python3dist(mrack)
python3-mrack-aws:
python-mrack-aws
python3-mrack-aws
python3.11-mrack-aws
python3-mrack-beaker:
python-mrack-beaker
python3-mrack-beaker
python3.11-mrack-beaker
python3-mrack-openstack:
python-mrack-openstack
python3-mrack-openstack
python3.11-mrack-openstack
python3-mrack-podman:
python-mrack-podman
python3-mrack-podman
python3.11-mrack-podman
python3-mrack-virt:
python-mrack-virt
python3-mrack-virt
python3.11-mrack-virt
Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review -b 2134387
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Python
Disabled plugins: Haskell, SugarActivity, R, Java, Perl, C/C++, PHP, Ocaml, fonts
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH
We agreed with Tibor, that we will deal with the following issues post-review.
[!]: Fully versioned dependency in subpackages if applicable.
Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in mrack-
cli , python3-mracklib , python3-mrack-aws , python3-mrack-beaker ,
python3-mrack-openstack , python3-mrack-podman , python3-mrack-virt
[!]: %check is present and all tests pass.
[x]: Macros in Summary, %description expandable at SRPM build time.
Note: Macros in: mrack (description)
(fedscm-admin): The Pagure repository was created at https://src.fedoraproject.org/rpms/mrack Package is now in repositories, closing review. |