Keystone server does not define "enabled" attribute for Region but mentions in v3 regions.py

[Nisha Yadav]

The bug was discovered while writing the region functional tests [1]. The create() and update() calls [2] in regions.py mention the "enabled" attribute, but the specs [3] don't mention it and the code [4] doesn't support it. We don't check for "enabled" in the region schema either [5].

So, it's being stored as an extra attribute and it even works if one passes {'enabled': 'WHATEVER'}

[1] https://review.openstack.org/#/c/339158/
[2] https://github.com/openstack/python-keystoneclient/blob/master/keystoneclient/v3/regions.py
[3] http://specs.openstack.org/openstack/keystone-specs/api/v3/identity-api-v3.html#regions-v3-regions
[4] https://github.com/openstack/keystone/blob/master/keystone/catalog/backends/sql.py#L33-L49
[5] https://github.com/openstack/keystone/blob/master/keystone/catalog/schema.py#L17-L43

[David Lyle (david-lyle)]

Just adding some additional data. python-keystoneclient by default adds "enabled": True, but also accepts an enabled parameter on region create. The comment indicates that if "enabled" is False, the region will not be added to the catalog. Now for the kicker, since there is not an "enabled" attribute in the region schema, the "enabled" value gets added to the extra blob. And strangely, the extra blob is not update-able. The enabled trigger seems like it should either be removed altogether or in the schema so that it can be updated.

[David Lyle (david-lyle)]

after further testing enabled seems to do nothing in v3 as endpoints added to the regions with enabled being true or false both show up in the catalog returned with the token. This seems to be a documentation issue with python-keystoneclient and taking a parameter that in v3 seems to do nothing.

[Lance Bragstad (lbragstad)]

Adding python-keystoneclient to this bug report so that we can get a release that doesn't assume `enabled` attributes for regions. Keeping this open for keystone so that we can make sure we're not documenting it, officially or in code comments.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/594921

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/594921
Committed: https://git.openstack.org/cgit/openstack/python-keystoneclient/commit/?id=b7db5668c1223908987060a767078f010c83df6f
Submitter: Zuul
Branch: master

commit b7db5668c1223908987060a767078f010c83df6f
Author: Vishakha Agarwal <email address hidden>
Date: Wed Aug 22 15:35:29 2018 +0530

    Deprecate region enabled parameter

    We don't check for "enabled" in the region
    anywhere thus deprecating it from the create()
    and update calls of the v3/region.py. We dont
    use it in schema [1] as well as [2].

    [1] https://github.com/openstack/keystone/blob/master/keystone/catalog/schema.py#L34
    [2] https://github.com/openstack/keystone/blob/master/keystone/catalog/backends/sql.py#L33-L49

    Change-Id: I0257d5d42916e3b4d008e592d54eeeebec591633
    Partial-Bug: #1615076