Bug 2116843 - Review Request: python-azure-eventhub - Microsoft Azure Event Hubs Client Library for Python
Summary: Review Request: python-azure-eventhub - Microsoft Azure Event Hubs Client Lib...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Jakub Kadlčík
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-08-09 12:04 UTC by Major Hayden 🤠
Modified: 2022-09-13 15:22 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2022-09-13 15:22:14 UTC
Type: ---
Embargoed:
jkadlcik: fedora-review+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Fedora Pagure releng/fedora-scm-requests issue 47554 0 None None None 2022-09-13 11:31:59 UTC

Comment 1 Jakub Kadlčík 2022-09-07 14:48:11 UTC
Hello Major,
thank you for the package.

I couldn't properly test it but I tried to import a bunch of classes
and it looks alright.

> # No tests provided by upstream. ð¢

I think I disagree? When I downloaded the tarball from PyPI, tests are inside.


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

So I think this can be done unconditionally.


> %global _description %{expand:
> Microsoft Azure Event Hubs Client Library for Python}

Please don't copy-paste the Summary here. Fortunatelly, there is a lot
of text in the package README, that can be used as a proper
description. 


> %doc README.md CHANGELOG.md

I think we should also install the LICENSE file here (using %license macro)


> [ ]: Package does not own files or directories owned by other packages.
>      Note: Dirs in package are owned also by: /usr/lib/python3.11/site-
>      packages/azure(python3-azure-mgmt-iothub, python3-azure-mgmt-
>      recoveryservicesbackup, python3-azure-mgmt-security, python3-azure-

The fedora-review tool complains about this. It seems to me that this
package tries to claim ownership of 

/usr/lib/python3.11/site-packages/azure/

but instead, it should try to own only

/usr/lib/python3.11/site-packages/azure/eventhub/


---

Also, please note that the package works only for F37+, on older
versions it fails to build because of

    No matching package to install: 'python3dist(typing-extensions) >= 4.0.1'

Which is okay, I am just pointing it out.

Comment 2 Jakub Kadlčík 2022-09-07 14:50:31 UTC
Ah, I forgot one more thing,


> Version:        5.10.0

There is already 5.10.1 on PyPI :-)

Comment 3 Major Hayden 🤠 2022-09-09 18:49:29 UTC
Thanks for taking a look, Jakub!

I was able to get the tests working, but a test fixture is missing from the PyPi package from upstream, so I had to skip some tests.

The test conditional (%if %{with tests}) was recommended by several Python package maintainers and is in use with about 90+ Azure packages so far. Also, the description in the README talks mainly about Azure's eventhub service capabilities and seems more like an advertisement. This package is purely an API client for that service.

The pyproject macros automatically pull in the license into %files:

❯ rpm -qlp python3-azure-eventhub-5.10.1-1.fc38.noarch.rpm | grep -i license
/usr/lib/python3.11/site-packages/azure_eventhub-5.10.1.dist-info/LICENSE

As for the '/usr/lib/python3.11/site-packages/azure/' directory, this is done via the pyproject macros automatically and it's in use with the other Azure packages without issues.

I also updated to 5.10.1. This version requires python3-uamqp >= 1.6 and I've put that update in today: https://bodhi.fedoraproject.org/updates/FEDORA-2022-8c9ce90cf9

-----

Spec URL: https://download.copr.fedorainfracloud.org/results/mhayden/pkgreview/fedora-rawhide-x86_64/04831021-python-azure-eventhub/python-azure-eventhub.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/mhayden/pkgreview/fedora-rawhide-x86_64/04831021-python-azure-eventhub/python-azure-eventhub-5.10.1-1.fc38.src.rpm

Comment 4 Jakub Kadlčík 2022-09-11 19:42:37 UTC
> I was able to get the tests working, but a test fixture is missing
> from the PyPi package from upstream, so I had to skip some tests. 

Perfect, thank you very much!

> # No tests provided by upstream. ð¢

That means this comment is not true. Can you please drop it / change
it? At least the special characters are unnecessary

> The test conditional (%if %{with tests}) was recommended by several
> Python package maintainers and is in use with about 90+ Azure packages
> so far. 

Okay, no problem here, thank you for the explanation :-)


> Also, the description in the README talks mainly about Azure's
> eventhub service capabilities and seems more like an advertisement. 

IDK, this doesn't seem a bad description to me:


The Azure Event Hubs client library allows for publishing and
consuming of Azure Event Hubs events and may be used to: 

- Emit telemetry about your application for business intelligence and
  diagnostic purposes. 

- Publish facts about the state of your application which interested
  parties may observe and use as a trigger for taking action. 

- Observe interesting operations and interactions happening within
  your business or other ecosystem, allowing loosely coupled systems
  to interact without the need to bind them together.

- Receive events from one or more publishers, transform them to better
  meet the needs of your ecosystem, then publish the transformed
  events to a new stream for consumers to observe. 


...

As a person that knows nothing about Azure, I get the idea from it,
what I could use the library for.

We can have something entirely else for the description, I would just
like to avoid copy-pasting the Summary. If you would like, can you
write your own 2-3 sentences explaining the library?


> As for the '/usr/lib/python3.11/site-packages/azure/' directory, this
> is done via the pyproject macros automatically and it's in use with
> the other Azure packages without issues. 

Ok, no problem here.


> The pyproject macros automatically pull in the license into %files:
> ❯ rpm -qlp python3-azure-eventhub-5.10.1-1.fc38.noarch.rpm | grep -i license
> /usr/lib/python3.11/site-packages/azure_eventhub-5.10.1.dist-info/LICENSE

That's true but per the pyproject-rpm-macros README
https://src.fedoraproject.org/rpms/pyproject-rpm-macros

> %pyproject_save_files can automatically mark license files with
> %license macro [...] Only license files declared via PEP 639
> %License-File field are detected. 

Which is not the case for this package. We have only
license='MIT License' field.

So to be honest, I don't know if in this case we have to or don't have to
use the %license macro manually. But since it's just one line, I would
play it safe and use the %license macro.


> I also updated to 5.10.1

Perfect, thank you.

Comment 5 Major Hayden 🤠 2022-09-12 13:08:48 UTC
(In reply to Jakub Kadlčík from comment #4)
> That means this comment is not true. Can you please drop it / change
> it? At least the special characters are unnecessary

Oops, I fixed it but it didn't make it into the SRPM. 🤦🏻‍♂️

> We can have something entirely else for the description, I would just
> like to avoid copy-pasting the Summary. If you would like, can you
> write your own 2-3 sentences explaining the library?

I think your suggestion will work. Fixed.

> So to be honest, I don't know if in this case we have to or don't have to
> use the %license macro manually. But since it's just one line, I would
> play it safe and use the %license macro.

Added it.

Thank you!

Spec URL: https://download.copr.fedorainfracloud.org/results/mhayden/pkgreview/fedora-rawhide-x86_64/04833158-python-azure-eventhub/python-azure-eventhub.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/mhayden/pkgreview/fedora-rawhide-x86_64/04833158-python-azure-eventhub/python-azure-eventhub-5.10.1-1.fc38.src.rpm

Comment 6 Jakub Kadlčík 2022-09-12 20:50:19 UTC
Thank you for the changes, Major.



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

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



===== 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", "MIT License", "*No copyright* MIT
     License". 20 files have unknown license. Detailed output of
     licensecheck in /home/jkadlcik/2116843-python-azure-
     eventhub/licensecheck.txt
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.11/site-
     packages/azure(python3-azure-mgmt-cosmosdb, python3-azure-mgmt-
     servicefabric, python3-azure-mgmt-maps, python3-azure-mgmt-
     imagebuilder, python3-azure-mgmt-servicelinker, python3-azure-common,
     python3-azure-mgmt-web, python3-azure-mgmt-batch, python3-azure-mgmt-
     compute, python3-azure-mgmt-dns, python3-azure-mgmt-network,
     python3-azure-cosmos, python3-azure-synapse-artifacts, python3-azure-
     mgmt-storage, python3-azure-mgmt-sqlvirtualmachine, python3-azure-
     mgmt-privatedns, python3-azure-keyvault-certificates, python3-azure-
     mgmt-datamigration, python3-azure-storage-common, python3-azure-mgmt-
     recoveryservices, python3-azure-mgmt-msi, python3-azure-mgmt-security,
     python3-azure-mgmt-synapse, python3-azure-batch, python3-azure-mgmt-
     search, python3-azure-mgmt-netapp, python3-azure-mgmt-
     appconfiguration, python3-azure-mgmt-hybridcompute, python3-azure-
     mgmt-subscription, python3-azure-mgmt-deploymentmanager,
     python3-azure-mgmt-servicefabricmanagedclusters, python3-azure-data-
     tables, python3-azure-mgmt-iothubprovisioningservices, python3-azure-
     synapse-managedprivateendpoints, python3-azure-mgmt-extendedlocation,
     python3-azure-mgmt-managedservices, python3-azure-mgmt-cdn, azure-cli,
     python3-azure-mgmt-billing, python3-azure-mgmt-keyvault,
     python3-azure-mgmt-managementgroups, python3-azure-mgmt-hdinsight,
     python3-azure-mgmt-loganalytics, python3-azure-servicebus,
     python3-azure-graphrbac, python3-azure-mgmt-media, python3-azure-
     synapse-accesscontrol, python3-azure-mgmt-cognitiveservices,
     python3-azure-mgmt-rdbms, python3-azure-mgmt-reservations,
     python3-azure-mgmt-policyinsights, python3-azure-synapse-spark,
     python3-azure-mgmt-azurestackhci, python3-azure-mgmt-databoxedge,
     python3-azure-mgmt-trafficmanager, python3-azure-multiapi-storage,
     python3-azure-mgmt-core, python3-azure-mgmt-devtestlabs,
     python3-azure-mgmt-authorization, python3-azure-mgmt-iothub,
     python3-azure-mgmt-signalr, python3-azure-mgmt-servicebus,
     python3-azure-mgmt-sql, python3-azure-mgmt-applicationinsights,
     python3-azure-mgmt-containerinstance, python3-azure-mgmt-
     containerservice, python3-azure-mgmt-kusto, python3-azure-mgmt-
     botservice, python3-azure-keyvault-keys, python3-azure-mgmt-redis,
     python3-azure-mgmt-batchai, python3-azure-core, python3-azure-mgmt-
     containerregistry, python3-azure-appconfiguration, python3-azure-
     keyvault-administration, python3-azure-mgmt-advisor, python3-azure-
     mgmt-recoveryservicesbackup, python3-azure-mgmt-redhatopenshift,
     python3-azure-mgmt-resource, python3-azure-mgmt-iotcentral,
     python3-azure-identity, python3-azure-keyvault-secrets, python3-azure-
     mgmt-marketplaceordering, python3-azure-mgmt-apimanagement,
     python3-azure-mgmt-monitor, python3-azure-mgmt-eventhub,
     python3-azure-datalake-store, python3-azure-mgmt-eventgrid)
[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 61440 bytes in 2 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 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.
[?]: 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: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Cannot parse rpmlint output:


Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.2.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/licenses.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 1

python3-azure-eventhub.noarch: W: files-duplicate /usr/lib/python3.11/site-packages/azure/eventhub/aio/_transport/__init__.py /usr/lib/python3.11/site-packages/azure/eventhub/_eventprocessor/__init__.py:/usr/lib/python3.11/site-packages/azure/eventhub/_transport/__init__.py
 1 packages and 0 specfiles checked; 0 errors, 1 warnings, 0 badness; has taken 0.0 s



Source checksums
----------------
https://files.pythonhosted.org/packages/source/a/azure-eventhub/azure-eventhub-5.10.1.zip :
  CHECKSUM(SHA256) this package     : 2d5fa8edd3150852107eaf5ddb0618df82e08483f914dd3acc3a543ed9042c54
  CHECKSUM(SHA256) upstream package : 2d5fa8edd3150852107eaf5ddb0618df82e08483f914dd3acc3a543ed9042c54


Requires
--------
python3-azure-eventhub (rpmlib, GLIBC filtered):
    (python3.11dist(azure-core) < 2~~ with python3.11dist(azure-core) >= 1.14)
    (python3.11dist(uamqp) < 2~~ with python3.11dist(uamqp) >= 1.6)
    python(abi)
    python3.11dist(typing-extensions)



Provides
--------
python3-azure-eventhub:
    python-azure-eventhub
    python3-azure-eventhub
    python3.11-azure-eventhub
    python3.11dist(azure-eventhub)
    python3dist(azure-eventhub)



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review -b 2116843
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Perl, fonts, SugarActivity, Ocaml, Haskell, C/C++, PHP, R, Java
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 7 Major Hayden 🤠 2022-09-13 11:31:59 UTC
Thanks, Jakub! Repo requested: https://pagure.io/releng/fedora-scm-requests/issue/47554

Comment 8 Gwyn Ciesla 2022-09-13 13:49:04 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-azure-eventhub

Comment 9 Fedora Update System 2022-09-13 15:19:34 UTC
FEDORA-2022-cbc3df73b9 has been submitted as an update to Fedora 38. https://bodhi.fedoraproject.org/updates/FEDORA-2022-cbc3df73b9

Comment 10 Fedora Update System 2022-09-13 15:22:14 UTC
FEDORA-2022-cbc3df73b9 has been pushed to the Fedora 38 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.