Bug 1930954 - Review Request: python-aexpect - A python library to control interactive applications
Summary: Review Request: python-aexpect - A python library to control interactive appl...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Miro Hrončok
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-02-19 21:04 UTC by Merlin Mathesius
Modified: 2021-06-28 20:46 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-06-28 20:46:38 UTC
Type: ---
Embargoed:
mhroncok: fedora-review+


Attachments (Terms of Use)

Description Merlin Mathesius 2021-02-19 21:04:53 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/01994392-python-aexpect/python-aexpect.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/01994392-python-aexpect/python-aexpect-1.6.1-1.fc35.src.rpm

Description:
Aexpect is a python library used to control interactive applications, very
similar to pexpect. You can use it to control applications such as ssh, scp
sftp, telnet, among others.

Fedora Account System Username: merlinm

Note:
The python-aexpect package already exists in Fedora, but has been modular-only (as part of the avocado module) for quite some time. Thus, as noted in https://pagure.io/releng/issue/10025, a package review is required to bring it back as a regular package.

The content of the package in this review request is identical to what is planned to become the "latest" stream branch--but can't be committed because the branch EOL needs to be updated as noted in https://pagure.io/releng/issue/10018.

Comment 1 Miro Hrončok 2021-02-19 22:02:37 UTC
2 things that strike me as odd in the spec file:


1) License: GPLv2

The files have:

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

That should be GPLv2+



2) Requires: python3

 - The package installs to %{python3_sitelib} and has an autogenerated dependency on a specific Python version. This manual requirement is redundant.
 - This is in the "main package" section of the metadata, but the spec file only generates python3-aexpect hence the line seem unused.

Comment 2 Miro Hrončok 2021-02-20 10:10:42 UTC
Package Review
==============

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


Issues:
=======

The license tag does not match the content. Licensecheck output:


  *No copyright* GNU General Public License v2.0 or later
  -------------------------------------------------------
  aexpect-1.6.1/aexpect/__init__.py
  aexpect-1.6.1/aexpect/exceptions.py
  aexpect-1.6.1/aexpect/shared.py
  aexpect-1.6.1/aexpect/utils/astring.py
  aexpect-1.6.1/aexpect/utils/data_factory.py
  aexpect-1.6.1/aexpect/utils/genio.py
  aexpect-1.6.1/aexpect/utils/path.py
  aexpect-1.6.1/aexpect/utils/process.py
  aexpect-1.6.1/aexpect/utils/wait.py
  aexpect-1.6.1/scripts/aexpect_helper
  
  GNU General Public License v2.0 only
  ------------------------------------
  aexpect-1.6.1/debian/copyright
  
  GNU General Public License v2.0 or later
  ----------------------------------------
  aexpect-1.6.1/aexpect/client.py
  aexpect-1.6.1/aexpect/remote.py
  aexpect-1.6.1/aexpect/remote_door.py
  aexpect-1.6.1/aexpect/rss_client.py
  aexpect-1.6.1/setup.py
  aexpect-1.6.1/tests/test_client.py
  aexpect-1.6.1/tests/test_pass_fds.py
  aexpect-1.6.1/tests/test_remote_door.py
  
  GNU General Public License, Version 2
  -------------------------------------
  aexpect-1.6.1/LICENSE
  
  Unknown or generated
  --------------------
  aexpect-1.6.1/.travis.yml
  aexpect-1.6.1/Makefile
  aexpect-1.6.1/README.rst
  aexpect-1.6.1/debian/changelog
  aexpect-1.6.1/debian/compat
  aexpect-1.6.1/debian/control
  aexpect-1.6.1/debian/pyversions
  aexpect-1.6.1/debian/rules
  aexpect-1.6.1/debian/source/format
  aexpect-1.6.1/debian/source/options
  aexpect-1.6.1/debian/watch
  aexpect-1.6.1/python-aexpect.spec
  aexpect-1.6.1/requirements-travis.txt

---

rpmlint issues (justified):

  python3-aexpect.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/aexpect/rss_client.py 644 /usr/bin/python 


Suggestions and tips:
=====================

Remove `Requires: python3` (see above).

---

You can change:
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{version}.tar.gz#/%{gittar}
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{commit}.tar.gz#/%{gittar}
To:
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{version}/%{gittar}
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{commit}/%{gittar}
Or even:
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{version}/%{srcname}-%{version}.tar.gz
  Source0: https://github.com/avocado-framework/%{srcname}/archive/%{commit}/%{srcname}-%{shortcommit}.tar.gz
Or even:
  Source0: %{url}/archive/%{version}/%{srcname}-%{version}.tar.gz
  Source0: %{url}/archive/%{commit}/%{srcname}-%{shortcommit}.tar.gz

---

If you change:
  %check
  %if %{with_tests}
  selftests/checkall
  %endif
To:
  %if %{with_tests}
  %check
  selftests/checkall
  %endif

There will be no empty %check section in the log that could be confusing to the log reader (it was to me).

---

If you change:
  %{python3_sitelib}/aexpect-%{version}-py%{python3_version}.egg-info
To:
  %{python3_sitelib}/aexpect-%{version}-py%{python3_version}.egg-info/

rpmbuild will assert this is a directory and a specfile reader will know it is a directory just by reading it.
(I've seen cases when egg-info was a directory or a file depending on the content of the buildroot and upgrading from a directory to a file breaks RPM.)


===== 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", "GNU General Public License, Version
     2", "GNU General Public License v2.0 or later", "*No copyright* GNU
     General Public License v2.0 or later", "GNU General Public License
     v2.0 only". 13 files have unknown license. Detailed output of
     licensecheck in /home/churchyard/rpmbuild/FedoraReview/1930954-python-
     aexpect/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.
[-]: 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.
[!]: 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.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[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).
[?]: 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.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[?]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[?]: 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-aexpect-1.6.1-1.fc35.noarch.rpm
          python-aexpect-1.6.1-1.fc35.src.rpm
python3-aexpect.noarch: W: spelling-error %description -l en_US pexpect -> expect, p expect
python3-aexpect.noarch: W: spelling-error %description -l en_US scp -> cps, sci, sip
python3-aexpect.noarch: W: spelling-error %description -l en_US sftp -> ftp, ftps, s ftp
python3-aexpect.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/aexpect/rss_client.py 644 /usr/bin/python 
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper-3
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper-3.9
python-aexpect.src: W: spelling-error %description -l en_US pexpect -> expect, p expect
python-aexpect.src: W: spelling-error %description -l en_US scp -> cps, sci, sip
python-aexpect.src: W: spelling-error %description -l en_US sftp -> ftp, ftps, s ftp
2 packages and 0 specfiles checked; 1 errors, 9 warnings.




Rpmlint (installed packages)
----------------------------
python3-aexpect.noarch: W: spelling-error %description -l en_US pexpect -> expect, p expect
python3-aexpect.noarch: W: spelling-error %description -l en_US scp -> cps, sci, sip
python3-aexpect.noarch: W: spelling-error %description -l en_US sftp -> ftp, ftps, s ftp
python3-aexpect.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/aexpect/rss_client.py 644 /usr/bin/python 
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper-3
python3-aexpect.noarch: W: no-manual-page-for-binary aexpect_helper-3.9
1 packages and 0 specfiles checked; 1 errors, 6 warnings.



Source checksums
----------------
https://github.com/avocado-framework/aexpect/archive/1.6.1.tar.gz#/aexpect-1.6.1.tar.gz :
  CHECKSUM(SHA256) this package     : 40437382f7c4c273dbe45013fca8e7e5e0344eba332dc3aa0c59cc2e2aa67136
  CHECKSUM(SHA256) upstream package : 40437382f7c4c273dbe45013fca8e7e5e0344eba332dc3aa0c59cc2e2aa67136


Requires
--------
python3-aexpect (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)



Provides
--------
python3-aexpect:
    python-aexpect
    python3-aexpect
    python3.9-aexpect
    python3.9dist(aexpect)
    python3dist(aexpect)



Generated by fedora-review 0.7.0 (fed5495) last change: 2019-03-17
Command line :try-fedora-review -b 1930954 -m fedora-rawhide-x86_64 --mock-options=--enablerepo=local
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Python, Shell-api
Disabled plugins: Ruby, Java, fonts, PHP, C/C++, Perl, SugarActivity, R, Ocaml, Haskell
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 3 Merlin Mathesius 2021-03-17 19:37:41 UTC
Thank you for the detailed review. I believe I now have all of the above concerns addressed.

Note: I submitted an upstream fix for the rpmlint non-executable-script error that was just merged and is included as a patch.

New Spec URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/02079927-python-aexpect/python-aexpect.spec
New SRPM URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/02079927-python-aexpect/python-aexpect-1.6.1-2.fc35.src.rpm

Comment 4 Miro Hrončok 2021-03-18 16:59:40 UTC
Let me comment on the diff:

    --- python-aexpect.spec.old	2021-03-18 17:53:05.538218893 +0100
    +++ python-aexpect.spec	2021-03-18 17:52:52.754132043 +0100
    @@ -26,20 +26,22 @@
     
     Name: python-%{pkgname}
     Version: 1.6.1
    -Release: 1%{?gitrel}%{?dist}
    +Release: 2%{?gitrel}%{?dist}

Ack.

     Summary: A python library to control interactive applications
     
    -License: GPLv2
    -URL: https://github.com/avocado-framework/aexpect
    +License: GPLv2+ and GPLv2
    +URL: https://github.com/avocado-framework/%{srcname}
    
I see you changed the license to "GPLv2+ and GPLv2". I believe it should be "GPLv2+". What makes you think there are parts that don't allow later version? (This is the only remaining blocker for the review.)

I see you obfuscated the URL so it is harder to copy-paste from the spec file to the browser. What was the reason to do that? (This is not a blocker for the review, I am just curious.)

 
     %if 0%{?rel_build}
    -Source0: https://github.com/avocado-framework/%{srcname}/archive/%{version}.tar.gz#/%{gittar}
    +Source0: %{url}/archive/%{version}/%{gittar}
     %else
    -Source0: https://github.com/avocado-framework/%{srcname}/archive/%{commit}.tar.gz#/%{gittar}
    +Source0: %{url}/archive/%{commit}/%{gittar}
     %endif

Thanks.

    +# Remove vestigial python shebang line from rss_client.py that causes rpmlint errors.
    +# https://github.com/avocado-framework/aexpect/commit/a2c8252a36cbe90182774f48948d8e504832bd62.patch
    +Patch1: python-aexpect-1.6.1-remove-python-shebang.patch

Thanks.

     BuildArch: noarch
    -Requires: python3

Thanks.

     BuildRequires: python3-devel
     BuildRequires: python3-setuptools
     
    @@ -58,9 +60,9 @@
     
     %prep
     %if 0%{?rel_build}
    -%autosetup -n %{srcname}-%{version}
    +%autosetup -n %{srcname}-%{version} -p 1
     %else
    -%autosetup -n %{srcname}-%{commit}
    +%autosetup -n %{srcname}-%{commit} -p 1
     %endif

Ack.

     %build
    @@ -71,8 +73,8 @@
     ln -s aexpect_helper %{buildroot}%{_bindir}/aexpect_helper-%{python3_pkgversion}
     ln -s aexpect_helper %{buildroot}%{_bindir}/aexpect_helper-%{python3_version}
     
    -%check
     %if %{with_tests}
    +%check
     selftests/checkall
     %endif

Thanks.

    @@ -80,10 +82,14 @@
     %license LICENSE
     %doc README.rst
     %{python3_sitelib}/aexpect/
    -%{python3_sitelib}/aexpect-%{version}-py%{python3_version}.egg-info
    +%{python3_sitelib}/aexpect-%{version}-py%{python3_version}.egg-info/
     %{_bindir}/aexpect_helper*
     
Thanks.

     %changelog
    +* Wed Mar 17 2021 Merlin Mathesius <mmathesi> - 1.6.1-2
    +- Spec file cleanup following package review.
    +- Include upstream patch to fix rpmlint error.
    +

Ack.

     * Mon Feb 15 2021 Cleber Rosa <cleber> - 1.6.1-1
     - Sync with upstream release 1.6.1.
     - Dropped Python2 support completely

Comment 5 Merlin Mathesius 2021-03-18 20:31:33 UTC
(In reply to Miro Hrončok from comment #4)

Thank you for the follow-up.

>     -License: GPLv2
>     -URL: https://github.com/avocado-framework/aexpect
>     +License: GPLv2+ and GPLv2
>     +URL: https://github.com/avocado-framework/%{srcname}
>     
> I see you changed the license to "GPLv2+ and GPLv2". I believe it should be
> "GPLv2+". What makes you think there are parts that don't allow later
> version? (This is the only remaining blocker for the review.)

Confusion on my part. Corrected.

> I see you obfuscated the URL so it is harder to copy-paste from the spec
> file to the browser. What was the reason to do that? (This is not a blocker
> for the review, I am just curious.)

Source0 (referenced above in the review) originally started out with https://github.com/avocado-framework/%{srcname}/...  After adjusting it to use %{url} instead, I adjusted URL to match the original Source0 prefix referencing %{srcname}. That's all.

However, with this SPEC revision, I took your advice from BZ#1930948 (python-avocado review) and entirely dropped the unnecessary complexity and obfuscation of using %{srcname} and %{pkgname}.

New Spec URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/02081530-python-aexpect/python-aexpect.spec
New SRPM URL: https://download.copr.fedorainfracloud.org/results/merlinm/avocado/fedora-rawhide-x86_64/02081530-python-aexpect/python-aexpect-1.6.1-2.fc35.src.rpm

Thanks again!

Comment 6 Miro Hrončok 2021-03-18 21:45:42 UTC
Package APPROVED.

Comment 7 Merlin Mathesius 2021-06-28 20:46:38 UTC
python-aexpect-1.6.1-2.fc35 is now available in Fedora Rawhide. F34 and F33 releases have been created in Bodhi.


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