Bug 1966722 - Review Request: python-knack - A Command-Line Interface framework used by the Azure cli
Summary: Review Request: python-knack - A Command-Line Interface framework used by the...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ben Beasley
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-06-01 18:17 UTC by Major Hayden 🤠
Modified: 2021-06-12 01:19 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2021-06-10 01:11:07 UTC
Type: ---
Embargoed:
code: fedora-review+


Attachments (Terms of Use)

Comment 2 Ben Beasley 2021-06-02 16:24:57 UTC
Package Review
==============

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

===== Issues =====

- The patch for https://fedoraproject.org/wiki/Changes/DeprecatePythonMock
  looks reasonable:

    # Use unittest's mock that is built in for Python 3.x.
    sed -i 's/^import mock/from unittest import mock/' tests/*.py

  but it should be offered upstream. I went ahead and created a PR, which you
  can link in a comment:

    # https://github.com/microsoft/knack/pull/248

- While it’s not required, you could switch to the GitHub tarball if you want,
  in order to install the Markdown docs and the examples.

Because you are using pyproject-rpm-macros (a great idea!) I know you are
targeting only Fedora, not EPEL7 or EPEL8, since the pyproject-rpm-macros are
not available there. Considering that:

- You should remove

    %{?!python3_pkgversion:%global python3_pkgversion 3}

  and replace each occurrence of “%{python3_pkgversion}” with “3”. This macro
  is an EPEL-ism.

- While you can rewrite

    python%{python3_pkgversion}-pytest

  as

    python3-pytest

  the following “standardized name” style is more conventional in Fedora today
  (https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_automatic_provides_with_a_standardized_name):

    python3dist(pytest)

- You should remove

    %{?python_enable_dependency_generator}

  because the automatic dependency generator is enabled by default in Fedora
  (https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_automatically_generated_dependencies),
  so this line is unnecessary.

  Even if you were targeting EPEL, the automatic dependency generator is
  enabled by default in EPEL8 and is unavailable in EPEL7, so this line would
  still do nothing. It was only useful on versions of Fedora that are now
  end-of-life.

===== 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", "Expat License", "*No copyright* Expat
     License". 10 files have unknown license. Detailed output of
     licensecheck in /home/reviewer/1966722-python-knack/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 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: No rpmlint messages.
[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 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:
[-]: 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).
[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.
[x]: %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: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-knack-0.8.2-1.fc35.noarch.rpm
          python-knack-0.8.2-1.fc35.src.rpm
2 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
1 packages and 0 specfiles checked; 0 errors, 0 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/k/knack/knack-0.8.2.tar.gz :
  CHECKSUM(SHA256) this package     : 4eaa50a1c5e79d1c5c8e5e1705b661721b0b83a089695e59e229cc26c64963b9
  CHECKSUM(SHA256) upstream package : 4eaa50a1c5e79d1c5c8e5e1705b661721b0b83a089695e59e229cc26c64963b9


Requires
--------
python3-knack (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(argcomplete)
    python3.9dist(colorama)
    python3.9dist(jmespath)
    python3.9dist(pygments)
    python3.9dist(pyyaml)
    python3.9dist(tabulate)



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



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

Comment 3 Major Hayden 🤠 2021-06-02 19:10:32 UTC
(In reply to Ben Beasley from comment #2)
> - The patch for https://fedoraproject.org/wiki/Changes/DeprecatePythonMock
>   looks reasonable:
> 
>     # Use unittest's mock that is built in for Python 3.x.
>     sed -i 's/^import mock/from unittest import mock/' tests/*.py
> 
>   but it should be offered upstream. I went ahead and created a PR, which you
>   can link in a comment:
> 
>     # https://github.com/microsoft/knack/pull/248
> 

Thanks! Noted that in the spec.


> Because you are using pyproject-rpm-macros (a great idea!) I know you are
> targeting only Fedora, not EPEL7 or EPEL8, since the pyproject-rpm-macros are
> not available there. Considering that:

Good point. I'd like this to potentially work in EPEL, so I'll go back to the other python RPM macros instead.

> - You should remove
> 
>     %{?python_enable_dependency_generator}

Done.

Spec URL: https://download.copr.fedorainfracloud.org/results/mhayden/python-knack/fedora-rawhide-x86_64/02222348-python-knack/python-knack.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/mhayden/python-knack/fedora-rawhide-x86_64/02222348-python-knack/python-knack-0.8.2-1.fc35.src.rpm
fedora-review: https://copr-be.cloud.fedoraproject.org/results/mhayden/python-knack/fedora-rawhide-x86_64/02222348-python-knack/fedora-review/review.txt

Comment 4 Major Hayden 🤠 2021-06-03 15:51:22 UTC
Disregard. After working on packaging on the latest version of the Azure SDK/CLI, it turns out that this requirement is no longer needed.

Comment 5 Major Hayden 🤠 2021-06-03 16:17:09 UTC
Okay, this package *is* actually needed by python-azure-cli-core. 🤦🏻‍♂️

Comment 6 Ben Beasley 2021-06-03 19:26:53 UTC
Looks great. Package approved, with a few comments below.

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

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

===== Notes (no change required) =====

- This is not really required:

    %{?!python3_pkgversion:%global python3_pkgversion 3}

  since the macro is already defined to “3” on Fedora and EPEL8 (and to “36” on
  EPEL7). There should not be any current Fedora or EPEL release where it is
  undefined.
 
  It might be possible to dispense with the macro entirely and use just a
  literal “3”, if you are not targeting EPEL7. It is not clear to me if there
  is any reason to use the macro in EPEL8 or not.

  (If you are targeting EPEL7, you will need a few tweaks to get there—mostly,
  manual Requires guarded by “%if 0%{?el7}/%endif”,
  “%if 0%{?epel} == 7/%endif”, or similar, since EPEL7 lacks a Python
  dependency generator.)

- You can, if you like, write

    %{python3_sitelib}/knack-*.egg-info

  as

    %{python3_sitelib}/knack-py%{python3_version}.egg-info

  or

    %{python3_sitelib}/%{srcname}-py%{python3_version}.egg-info

  which works as a boilerplate pattern for most simple Python packages, but the
  version you have is fine.

===== 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", "Expat License", "*No copyright* Expat
     License". 10 files have unknown license. Detailed output of
     licensecheck in /home/reviewer/1966722-python-knack/2/1966722-python-
     knack/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 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: No rpmlint messages.
[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 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:
[-]: 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).
[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.
[x]: %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: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-knack-0.8.2-1.fc35.noarch.rpm
          python-knack-0.8.2-1.fc35.src.rpm
2 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
1 packages and 0 specfiles checked; 0 errors, 0 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/k/knack/knack-0.8.2.tar.gz :
  CHECKSUM(SHA256) this package     : 4eaa50a1c5e79d1c5c8e5e1705b661721b0b83a089695e59e229cc26c64963b9
  CHECKSUM(SHA256) upstream package : 4eaa50a1c5e79d1c5c8e5e1705b661721b0b83a089695e59e229cc26c64963b9


Requires
--------
python3-knack (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(argcomplete)
    python3.9dist(colorama)
    python3.9dist(jmespath)
    python3.9dist(pygments)
    python3.9dist(pyyaml)
    python3.9dist(tabulate)



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



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

Comment 7 Major Hayden 🤠 2021-06-03 20:09:56 UTC
(In reply to Ben Beasley from comment #6)
> Looks great. Package approved, with a few comments below.
> 
> Package Review
> ==============
> 
> Legend:
> [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
> 
> ===== Notes (no change required) =====
> 
> - This is not really required:
> 
>     %{?!python3_pkgversion:%global python3_pkgversion 3}
> 
>   since the macro is already defined to “3” on Fedora and EPEL8 (and to “36”
> on
>   EPEL7). There should not be any current Fedora or EPEL release where it is
>   undefined.
>  
>   It might be possible to dispense with the macro entirely and use just a
>   literal “3”, if you are not targeting EPEL7. It is not clear to me if there
>   is any reason to use the macro in EPEL8 or not.
> 
>   (If you are targeting EPEL7, you will need a few tweaks to get
> there—mostly,
>   manual Requires guarded by “%if 0%{?el7}/%endif”,
>   “%if 0%{?epel} == 7/%endif”, or similar, since EPEL7 lacks a Python
>   dependency generator.)

I see. Thanks for that!

> - You can, if you like, write
> 
>     %{python3_sitelib}/knack-*.egg-info
> 
>   as
> 
>     %{python3_sitelib}/knack-py%{python3_version}.egg-info
> 
>   or
> 
>     %{python3_sitelib}/%{srcname}-py%{python3_version}.egg-info
> 
>   which works as a boilerplate pattern for most simple Python packages, but
> the
>   version you have is fine.

Good to know. I always like re-using variables whenever I can.

Thank you!

Comment 8 Gwyn Ciesla 2021-06-03 20:15:58 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-knack

Comment 9 Fedora Update System 2021-06-03 20:55:01 UTC
FEDORA-2021-27518d9875 has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2021-27518d9875

Comment 10 Fedora Update System 2021-06-03 20:55:03 UTC
FEDORA-2021-93f12a179d has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2021-93f12a179d

Comment 11 Fedora Update System 2021-06-04 01:19:22 UTC
FEDORA-2021-27518d9875 has been pushed to the Fedora 34 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-27518d9875 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-27518d9875

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

Comment 12 Fedora Update System 2021-06-04 01:48:04 UTC
FEDORA-2021-93f12a179d has been pushed to the Fedora 33 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-93f12a179d \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-93f12a179d

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

Comment 13 Fedora Update System 2021-06-12 01:18:02 UTC
FEDORA-2021-27518d9875 has been pushed to the Fedora 34 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 14 Fedora Update System 2021-06-12 01:19:58 UTC
FEDORA-2021-93f12a179d has been pushed to the Fedora 33 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.