setup.cfg: [extras] for pip-installable driver requirements is out of date

Bug #1871846 reported by Brian Rosmaita
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
In Progress
Medium
Tushar Trambak Gite

Bug Description

Change-Id: I2200ce6f554df0c988eb39521ce4defd75998a85 introduced [extras] to setup.cfg. This section contains support for drivers and their dependency requirements. This allows a user to pip install cinder and optionally install a driver's required pypi based library.

We also maintain driver-requrements.txt, which most driver maintainers know about.

A few things here:
(1) There's an 'all' defined in [extras] that should include all the requirements for all drivers, but it doesn't.
(2) The versions listed in setup.cfg should be the same as driver-requirements.txt, but some of them aren't.
(3) Should probably put a comment in setup.cfg saying what's going on in there, particularly about how to name the section for a new driver (i guess it's the not-fully-qualified module name?)
(4) Check the "new driver review guide" and make sure it mentions setup.cfg
(5) there are instructions somewhere for introducing a new driver, should make sure they mention setup.cfg
(6) need to decide if driver-requirements.txt is still needed, or if we should *only* be putting this info in setup.cfg. If no driver-requirements.txt any more, revise the above. Otherwise:
(7) Should probably put a comment in driver-requrements.txt reminding people about the [extras] section of setup.cfg (both 'all' and their driver-specific section)
(8) would be nice to have a test to make sure driver-requirements.txt and setup.cfg are consistent
(9) would be nice to have a job that makes sure all the stuff in setup.cfg is in fact pip-installable

This is a lot of stuff, so feel free to split this up into additional bugs as necessary.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

Fix proposed to branch: master
Review: https://review.opendev.org/755647

Changed in cinder:
assignee: nobody → Sofia Enriquez (lsofia-enriquez)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on cinder (master)

Change abandoned by Sofia Enriquez (<email address hidden>) on branch: master
Review: https://review.opendev.org/755647

tags: added: doc
removed: docs
Changed in cinder:
assignee: Sofia Enriquez (lsofia-enriquez) → nobody
Changed in cinder:
assignee: nobody → Tushar Trambak Gite (tushargite96)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/855350

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.opendev.org/c/openstack/cinder/+/855350
Committed: https://opendev.org/openstack/cinder/commit/de7eca55359e5b5655da4f046c391c5982cb582c
Submitter: "Zuul (22348)"
Branch: master

commit de7eca55359e5b5655da4f046c391c5982cb582c
Author: tushargite96 <email address hidden>
Date: Wed Aug 31 15:28:18 2022 +0530

    setup.cfg: [extras] for pip-installable driver requirement

    This patch update the version in [extras] section in setup.cfg

    Partial-Bug: #1871846
    Change-Id: Iea45d041a1622216854614ca16ac6f3d0408f949

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.