py3 failure cfg.py - dictionary changed size during iteration

[Corey Bryant]

We came across the following issue while function testing keystone with py3: https://paste.ubuntu.com/p/d7s6KKPQDG/

  File "/usr/lib/python3/dist-packages/oslo_config/cfg.py", line 2652, in __iter__
    for key in itertools.chain(self._opts.keys(), self._groups.keys()):
RuntimeError: dictionary changed size during iteration

[OpenStack Infra (hudson-openstack)]

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

[Corey Bryant (corey.bryant)]

I went with a minimal fix on this. There are other uses of d.keys() in oslo.config but I'm not sure which ones modify the dictionary during iteration. Could change all uses to list(d.keys()) but that would somewhat defeat the purpose of the PEP.

[Ben Nemec (bnemec)]

Weird. This code doesn't seem like it would alter the opts. Is it possible that another thread registered an opt on the config object during the iteration?

[Launchpad Janitor (janitor)]

This bug was fixed in the package python-oslo.config - 1:6.4.0-0ubuntu2

---------------
python-oslo.config (1:6.4.0-0ubuntu2) cosmic; urgency=medium

  * d/p/py3-ensure-iter-list.patch: Ensure ConfigOpts __iter__ uses
    list(d.keys()) as d.keys() no longer returns a copy of keys in py3
    (LP: #1796163).

 -- Corey Bryant <email address hidden> Thu, 04 Oct 2018 15:52:48 -0400

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/rocky
Review: https://review.openstack.org/608235

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/608064
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=7ad146c48791bebee12fbdcdb1ac2427237343c3
Submitter: Zuul
Branch: master

commit 7ad146c48791bebee12fbdcdb1ac2427237343c3
Author: Corey Bryant <email address hidden>
Date: Thu Oct 4 15:29:36 2018 -0400

    python3: Ensure ConfigOpts __iter__ uses list(d.keys())

    d.keys() no longer returns a copy of the keys in Python 3.
    This is part of PEP 3106.

    Change-Id: Ie4897109c87d6dc2952c2eb35b83fe368fb31803
    Closes-Bug: #1796163

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/oslo.config 6.6.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/608235
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=1884c307a9502393d275e0d5c5b2e56343792908
Submitter: Zuul
Branch: stable/rocky

commit 1884c307a9502393d275e0d5c5b2e56343792908
Author: Corey Bryant <email address hidden>
Date: Thu Oct 4 15:29:36 2018 -0400

    python3: Ensure ConfigOpts __iter__ uses list(d.keys())

    d.keys() no longer returns a copy of the keys in Python 3.
    This is part of PEP 3106.

    Change-Id: Ie4897109c87d6dc2952c2eb35b83fe368fb31803
    Closes-Bug: #1796163

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/oslo.config 6.4.1 release.