[Bug 1967774] Review Request: python-fabric - High level SSH command execution

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=1967774

Ben Beasley <code@xxxxxxxxxxxxxxxxxx> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|                            |needinfo?(mhayden@xxxxxxxxx
                   |                            |m)



--- Comment #1 from Ben Beasley <code@xxxxxxxxxxxxxxxxxx> ---
Package Review
==============

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

===== Issues =====

- This is a patch, so it should be sent upstream, or an issue filed if the
  downstream patch is not upstreamable:

    # Pathlib is included in python3, so there's no need to bring in pathlib2,
which
    # is currently a dead project.
    sed -i 's/, "pathlib2"//' setup.py

  I sent a PR upstream, patching it a little differently so that it still
  worked with Python 2.7. Consider using my PR as a patch, instead, and linking
  it:

    # https://github.com/fabric/fabric/pull/2167
    Patch0:         fabric-2.6.0-conditional-pathlib2.patch

  At least link the PR in a comment above your sed command.

  It looks like upstream is far from active at the moment, and PR’s and issues
  are mostly languishing.

- Same here:

    # Upstream is supporting Python 2 + 3 at this time, so they rely on mock.
    sed -i 's/from mock/from unittest.mock/' tests/*.py fabric/testing/*.py

  And again, I sent a backwards-compatible PR upstream:

    # https://github.com/fabric/fabric/pull/2168
    Patch1:         fabric-2.6.0-conditional-mock.patch

- Please add

    %license LICENSE

  to the %files section.

- The License field says “MIT”, but it should be “BSD”.

- Since you are not using %pyproject_buildrequires, you must add

    BuildRequires:  python%{python3_pkgversion}-setuptools

  See
 
https://lists.fedoraproject.org/archives/list/devel@xxxxxxxxxxxxxxxxxxxxxxx/message/GCPGM34ZGEOVUHSBGZTRYR5XKHTIJ3T7/
  and
 
https://fedoraproject.org/wiki/Changes/Reduce_dependencies_on_python3-setuptools.

- You should attempt to run the tests. (It turns out that’s not going to be
  possible right now, but the attempt to do so helped me to find the missing
  dependencies mentioned in the next issue.) Please add:

    # Enable if https://bugzilla.redhat.com/show_bug.cgi?id=1949502 /
    # https://github.com/bitprophet/pytest-relaxed/issues/12 is # resolved:
    %bcond_with tests

    %if %{with tests}
    # Runtime dependencies, needed for testing
    BuildRequires:  python%{python3_pkgversion}-invoke
    BuildRequires:  python%{python3_pkgversion}-paramiko
    # Extra “pytest” (a superset of extra “testing”)
    BuildRequires:  python%{python3_pkgversion}-pytest
    # Missing from setup.py (only in requirements-dev.txt), but still needed
for
    # testing:
    BuildRequires:  python%{python3_pkgversion}-pytest-relaxed
    %endif

  and

    %check
    %if %{with tests}
    %pytest
    %endif

- Upstream defaults to using copies of six, lexicon, and decorator that are
  vendored by invoke as invoke.vendor.*. Since Fedora correctly removes the
  vendored copies from the python-invoke package, you must support the
  standalone packages in python-fabric.

  First, you must add BR’s (for testing) and (since the standalone dependencies
  are not in setup.py) also explicit Requires for the extra dependencies:

    %if %{with tests}
    # Runtime dependencies upstream assumed would be vendored with invoke, but
    # which we must use standalone
    BuildRequires:  python%{python3_pkgversion}-decorator
    BuildRequires:  python%{python3_pkgversion}-lexicon
    BuildRequires:  python%{python3_pkgversion}-six
    %endif

    # Runtime dependencies upstream assumed would be vendored with invoke, but
    # which we must use standalone
    Requires:       python%{python3_pkgversion}-decorator
    Requires:       python%{python3_pkgversion}-lexicon
    Requires:       python%{python3_pkgversion}-six

  Next, while upstream attempted to support using standalone dependencies (see
  the following changelog entry and also
  https://github.com/fabric/fabric/pull/1745)

    - :support:`1745 backported` Wrap any imports of ``invoke.vendor.*`` with
      ``try``/``except`` such that downstream packages which have removed
      ``invoke.vendor`` are still able to function by using stand-alone
      dependencies. Patch courtesy of Othmane Madjoudj.

  the unconditional imports of vendored packages slipped back in. So:

    # https://github.com/fabric/fabric/pull/2169
    Patch2:         fabric-2.6.0-wrap-invoke-vendor.patch

- It would be great if you could build and install the documentation in a -doc
  subpackage. I tried to, and I could get mostly-acceptable-looking
  documentation if I added

    # Patch out dependency on “releases” extension
    # (https://github.com/bitprophet/releases), which is not currently packaged
    sed -r -i '/extensions.append\("releases"\)/d' sites/www/conf.py

  in %prep, but there were still a bunch of broken intersphinx inventories and
  I got tired of messing with it. You may, or may not, be willing to work
  harder, or accept a “mostly-OK” result. If not, I would understand not
  building the documentation.

- Even if you don’t build the documentation, you should add:

    %doc README.rst

- A man page for a CLI tool is always wanted
  (https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages). The
  help2man tool actually does a pretty good job in this case:

    BuildRequires:  help2man
    # You also must enable the BR’s for invoke/paramiko/decorator/lexicon/six
    # even if tests are disabled.

    %build
    […]
    # Entry point script that allows us to use help2man before installing
    cat > fab <<'EOF'
    #!%{__python3}
    from fabric.main import program
    program.run()
    EOF
    chmod +x fab
    PYTHONPATH="${PWD}" help2man --no-info --output fab.1 ./fab

    %install
    […]
    install -d %{buildroot}%{_mandir}/man1
    install -t %{buildroot}%{_mandir}/man1 -m 0644 -p fab.1

    %files …
    %{_mandir}/man1/fab.1*

===== 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.
[!]: 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "BSD 2-clause "Simplified" License", "Unknown or generated".
     102 files have unknown license. Detailed output of licensecheck in
     /home/reviewer/1967774-python-fabric/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.

     Upstream expects bundled dependencies under invoke.vendor, which are not
     available in Fedora. More Requires are needed; see Issues.

[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.
[x]: Package complies to the Packaging Guidelines

     (except as noted)

[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 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 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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 0 bytes in 0 files.
[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

     (except as noted)

[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.
[!]: Final provides and requires are sane (see attachments).

     More Requires are needed, as previously noted.

[!]: Package functions as described.

     Package is broken with missing Requires.

[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-fabric-2.6.0-1.fc35.noarch.rpm
          python-fabric-2.6.0-1.fc35.src.rpm
python3-fabric.noarch: W: spelling-error %description -l en_US subprocess ->
sub process, sub-process, processors
python3-fabric.noarch: W: no-documentation
python3-fabric.noarch: W: no-manual-page-for-binary fab
python-fabric.src: W: spelling-error %description -l en_US subprocess -> sub
process, sub-process, processors
2 packages and 0 specfiles checked; 0 errors, 4 warnings.




Rpmlint (installed packages)
----------------------------
python3-fabric.noarch: W: spelling-error %description -l en_US subprocess ->
sub process, sub-process, processors
python3-fabric.noarch: W: no-documentation
python3-fabric.noarch: W: no-manual-page-for-binary fab
1 packages and 0 specfiles checked; 0 errors, 3 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/f/fabric/fabric-2.6.0.tar.gz :
  CHECKSUM(SHA256) this package     :
47f184b070272796fd2f9f0436799e18f2ccba4ee8ee587796fca192acd46cd2
  CHECKSUM(SHA256) upstream package :
47f184b070272796fd2f9f0436799e18f2ccba4ee8ee587796fca192acd46cd2


Requires
--------
python3-fabric (rpmlib, GLIBC filtered):
    (python3.9dist(invoke) < 2 with python3.9dist(invoke) >= 1.3)
    /usr/bin/python3
    python(abi)
    python3.9dist(paramiko)
    python3.9dist(setuptools)



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



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


-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are always notified about changes to this product and component
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux