Bug 1923678 - Review Request: openresolv - DNS management framework
Summary: Review Request: openresolv - DNS management framework
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: aegorenk
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 668153 1923727
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-02-01 17:25 UTC by Petr Menšík
Modified: 2021-06-04 15:57 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-06-04 15:57:36 UTC
Type: ---
Embargoed:
aegorenk: fedora-review+


Attachments (Terms of Use)

Description Petr Menšík 2021-02-01 17:25:07 UTC
Spec URL: https://raw.githubusercontent.com/pemensik/openresolv/fedora/openresolv.spec
SRPM URL: https://fedorapeople.org/~pemensik/srpm/openresolv-3.12.0-1.src.rpm
Description: Implementation independent maintenance of /etc/resolv.conf scripts.
  Provides resolvconf implementation.
Fedora Account System Username: pemensik

Comment 1 Petr Menšík 2021-02-01 17:27:11 UTC
It was originally reviewed as bug #668153, which were later closed.

I still think that provided package is useful in several use cases, including split dns configuration independent on local DNS cache used.

Comment 2 Petr Menšík 2021-02-01 17:28:52 UTC
Prepared COPR repository with this package: https://copr.fedorainfracloud.org/coprs/pemensik/openresolv/

Comment 3 Petr Menšík 2021-02-01 17:54:56 UTC
Originally this package was blocked by systemd package. Now it uses alternatives [1] to provide just alternative to resolvconf. It resets and breaks resolvectl link when uninstalled.
More details in bug #1923727.

1. https://docs.fedoraproject.org/en-US/packaging-guidelines/Alternatives/

Comment 4 aegorenk 2021-02-03 14:18:41 UTC
[1] https://fedoraproject.org/wiki/Licensing:Main?rd=Licensing#Good_Licenses
[2] https://docs.fedoraproject.org/en-US/packaging-guidelines/Alternatives/

Issues:

1. License.
    "BSD License (two clause)" from list [1] is the most similar I can find to the provided license, it's short name should be "BSD"

2. Requires.
    Shouldn't the following two Requires be added?
    Requires(post): %{_sbindir}/update-alternatives
    Requires(postun): %{_sbindir}/update-alternatives

3. According to [2]:
    * If a package is using alternatives, the files which would otherwise conflict MUST be installed with an appropriate suffix (for example: %{_sbindir}/sendmail.postfix instead of %{_sbindir}/sendmail), the original locations MUST be touched (for example: touch %{_sbindir}/sendmail), the links set up by alternatives MUST be listed as %ghost in the file list and proper Requires: MUST be added, like in the examples below.

    Could you add:
%install
...
touch %{buildroot}%{_sbindir}/resolvconf
...
%files
...
%ghost %{_sbindir}/resolvconf

4. I'm not sure if it makes sense, but please consider the following:
%files
...
%{_libexecdir}/resolvconf/*
...
^ this code uses a generic name "resolveconf" for a directory. As far as I know at the momnent there are no other packages provides same directory, but it looks dangarous when package provides directory with this kind of generic name. I think it can cause troubles in case there'll be another package (alternative to openresolv) in future. Can this directory also be handled by alternatives system? In this case package will provide %{_libexecdir}/resolvconf.%{name}/ which will be pointed by symlink %{_libexecdir}/resolvconf/

5. Please handle the following rpmlint warnings/errors:

Rpmlint
-------
Checking: openresolv-3.12.0-1.noarch.rpm
          openresolv-3.12.0-1.src.rpm
openresolv.noarch: W: invalid-license BSD-2-Clause
openresolv.noarch: E: non-executable-script /usr/libexec/resolvconf/libc.d/avahi-daemon 644 /bin/sh
openresolv.noarch: E: non-executable-script /usr/libexec/resolvconf/libc.d/mdnsd 644 /bin/sh
openresolv.src: W: invalid-license BSD-2-Clause


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

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


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


===== 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 2-clause "Simplified" License". 6
     files have unknown license. Detailed output of licensecheck in
     /home/eam/tmp/openresolv/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.
[!]: 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]: %config files are marked noreplace or the reason is justified.
[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]: No %config files under /usr.
[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.
[!]: 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.
[-]: %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.


Generated by fedora-review 0.7.6 (b083f91) last change: 2020-11-10
Command line :/usr/bin/fedora-review -rn openresolv-3.12.0-1.src.rpm
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic
Disabled plugins: SugarActivity, Haskell, R, Ocaml, PHP, C/C++, Java, Python, fonts, Perl
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 5 Petr Menšík 2021-02-09 05:04:01 UTC
Thank you for review! Sure, I forgot to add post and postun requirements. Added that, fixed %ghost files.

I don't think %libexec/resolvconf is a problem. In unlikely scenario another resolvconf would arrive, I would just use Conflicts: instead. Those dependencies are small with almost no requirements. It is easier to remove the package, than to switch between multiple versions. With exception of systemd, which is impossible to uninstall. There can be only one resolvconf active anyway.

I do not think it is necessary to make its directory alternative too. I think this directory works as place to put own modifications, so it should be real directory, not just symlink.
I am not sure how %_libexecdir is good idea however, debian uses /lib/resolvconf. Moving it to %_usr/lib/resolvconf might work, similar to systemd unit files. But that seems as a cosmetic difference only.

Changes are at the same URL as before.

Comment 6 Petr Menšík 2021-02-09 05:26:59 UTC
Because not a single file in libexec is executable, I think belongs more to lib directory. So instead of %_libdir, I used %_prefix/lib. Departing from OpenSuSE closer to Debian and to defaults autodetected by its configure anyway.

Comment 7 aegorenk 2021-02-10 14:23:41 UTC
# rpm -e openresolv
warning: %postun(openresolv-3.12.0-1.noarch) scriptlet failed, exit status 2

I think the reason for that is the:
%{_sbindir}/update-alternatives --remove-slave resolvconf %{_sbindir}/resolvconf.%{name} resolvconf.8%{?manext}

$ man update-alternatives
...
       --remove name path
              Remove  an  alternative and all of its associated slave links....
...

As I understand slave will be deleted when you delete the master alternative with:
%{_sbindir}/update-alternatives --remove resolvconf %{_sbindir}/resolvconf.%{name}

so no need for the second statement.

Comment 8 aegorenk 2021-02-10 14:45:23 UTC
Just to make it clear by "no need for the second statement" I mean no need for:
%{_sbindir}/update-alternatives --remove-slave resolvconf %{_sbindir}/resolvconf.%{name} resolvconf.8%{?manext}

That looks strange for me that update-alternatives doesn't produce any error message:
$ sudo /usr/sbin/update-alternatives --remove resolvconf /usr/sbin/resolvconf.openresolv
$ echo $?
0
$ sudo /usr/sbin/update-alternatives --remove-slave resolvconf /usr/sbin/resolvconf.openresolv  resolvconf.8.gz
$ echo $?
2

Should it be reported?

Comment 9 Petr Menšík 2021-02-11 17:16:34 UTC
Thanks, indeed it should be removed just by single invocation. I tried just updates. Fixed.

I am not sure, but it won't print even with --verbose flag. There might be some reason for it, but not well explained in documentation. I think it would not hurt raising it a bug, they can always close it.

Comment 10 aegorenk 2021-02-12 11:52:23 UTC
Looks good to me.
Approved.

Comment 11 Mohan Boddu 2021-02-17 14:41:41 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/openresolv

Comment 12 Petr Menšík 2021-06-04 15:57:36 UTC
Built into rawhide, https://src.fedoraproject.org/rpms/openresolv


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