Bug 1929941 - Review Request: python3-pyserial - Python serial port access library
Summary: Review Request: python3-pyserial - Python serial port access library
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1402890
TreeView+ depends on / blocked
 
Reported: 2021-02-18 01:56 UTC by Scott K Logan
Modified: 2021-04-07 15:48 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2021-04-07 15:48:14 UTC
Type: ---
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description Scott K Logan 2021-02-18 01:56:02 UTC
Spec URL: https://cottsay.fedorapeople.org/python3-pyserial/python3-pyserial.spec
SRPM URL: https://cottsay.fedorapeople.org/python3-pyserial/python3-pyserial-3.4-11.el7.src.rpm

Description:
This module encapsulates the access for the serial port. It provides backends
for standard Python running on Windows, Linux, BSD (possibly any POSIX
compliant system) and Jython. The module named "serial" automatically selects
the appropriate backend.

Fedora Account System Username: cottsay

Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=62195588

NOTE: Pyserial is already packaged for Fedora and RHEL. This package will offer a Python 3.6 sub-package for EPEL 7. To prevent source package name collisions between RHEL and EPEL, the Fedora package cannot be used for this purpose, and a new package must be created when a source package name unique within RHEL and EPEL.

This process of re-reviewing an existing package for creating a Python 3 package for EPEL was also employed in these two reviews previously:
https://bugzilla.redhat.com/show_bug.cgi?id=1698610
https://bugzilla.redhat.com/show_bug.cgi?id=1697567

Reference spec from Fedora: https://src.fedoraproject.org/rpms/pyserial/blob/rawhide/f/pyserial.spec

Thanks!

Comment 1 Robert-André Mauchin 🐧 2021-03-10 09:32:16 UTC
 - You must install the license file with %license not %doc

 - Globbing the entire %{python3_sitelib}/* is forbidden, you should be more specific instead

%files -n python%{python3_pkgversion}-pyserial
%license LICENSE.txt
%doc CHANGES.rst README.rst examples
%{python3_sitelib}/*
%{_bindir}/miniterm-3.py
%{_bindir}/miniterm-%{python3_version}.py

 - You should build the documentation with Sphinx

 - Run the test suite

 - Remove these shebangs in %prep:

python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/__init__.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/rs485.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/serialposix.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/threaded/__init__.py 644 /usr/bin/env python3
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_common.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_linux.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_osx.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_posix.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/miniterm.py 644 /usr/bin/env python



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

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


Issues:
=======
- Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
  Note: Package contains %{pythonX_site(lib|arch)}/* in %files
  See: https://pagure.io/packaging-committee/issue/782
- 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.
  Note: License file LICENSE.txt is not marked as %license
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/LicensingGuidelines/#_license_text


===== 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", "BSD 3-clause "New" or "Revised"
     License". 77 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/python3-pyserial/review-
     python-pyserial/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.
[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 133120 bytes in 15 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]: Package requires other packages for directories it uses.
[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 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]: 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.
[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.

===== 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-pyserial-3.4-11.fc35.noarch.rpm
          python-pyserial-3.4-11.fc35.src.rpm
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/__init__.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/rs485.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/serialposix.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/threaded/__init__.py 644 /usr/bin/env python3
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_common.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_linux.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_osx.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/list_ports_posix.py 644 /usr/bin/env python
python3-pyserial.noarch: E: non-executable-script /usr/lib/python3.9/site-packages/serial/tools/miniterm.py 644 /usr/bin/env python
python3-pyserial.noarch: E: env-script-interpreter /usr/share/doc/python3-pyserial/examples/port_publisher.py /usr/bin/env python
python3-pyserial.noarch: E: env-script-interpreter /usr/share/doc/python3-pyserial/examples/rfc2217_server.py /usr/bin/env python
python3-pyserial.noarch: E: env-script-interpreter /usr/share/doc/python3-pyserial/examples/tcp_serial_redirect.py /usr/bin/env python
python3-pyserial.noarch: E: env-script-interpreter /usr/share/doc/python3-pyserial/examples/wxSerialConfigDialog.py /usr/bin/env python
python3-pyserial.noarch: E: env-script-interpreter /usr/share/doc/python3-pyserial/examples/wxTerminal.py /usr/bin/env python
python3-pyserial.noarch: W: no-manual-page-for-binary miniterm-3.9.py
python3-pyserial.noarch: W: no-manual-page-for-binary miniterm-3.py
2 packages and 0 specfiles checked; 15 errors, 2 warnings.

Comment 2 Scott K Logan 2021-03-15 02:44:30 UTC
I had taken the pyserial spec from rawhide and made as few modifications as possible to make the package work for EPEL 7. Clearly the package has some things to address to meet today's packaging standards.

I just started over and created a spec as if I was creating a new package. Since I'll be maintaining the package in EPEL 7, it makes sense.

Thanks for your initial review. Please take a look at the re-written package:

Spec URL: https://cottsay.fedorapeople.org/python3-pyserial/python3-pyserial.spec
SRPM URL: https://cottsay.fedorapeople.org/python3-pyserial/python3-pyserial-3.4-12.el7.src.rpm
Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=63796203

Thanks!

--scott

Comment 3 Robert-André Mauchin 🐧 2021-03-15 08:33:33 UTC
Package approved.

Comment 4 Fedora Update System 2021-03-22 17:26:09 UTC
FEDORA-EPEL-2021-f3142ed08f has been submitted as an update to Fedora EPEL 7. https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2021-f3142ed08f

Comment 5 Fedora Update System 2021-03-23 02:11:19 UTC
FEDORA-EPEL-2021-f3142ed08f has been pushed to the Fedora EPEL 7 testing repository.

You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2021-f3142ed08f

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

Comment 6 Fedora Update System 2021-04-07 15:48:14 UTC
FEDORA-EPEL-2021-f3142ed08f has been pushed to the Fedora EPEL 7 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.