neutron-sanity-check fails with no such group [ml2]

[Hyunsun Moon]

neutron-sanity-check fails in Queens.

ubuntu@devstack-controller:~$ neutron-sanity-check
Traceback (most recent call last):
  File "/usr/local/bin/neutron-sanity-check", line 10, in <module>
    sys.exit(main())
  File "/opt/stack/neutron/neutron/cmd/sanity_check.py", line 396, in main
    setup_conf()
  File "/opt/stack/neutron/neutron/cmd/sanity_check.py", line 38, in setup_conf
    cfg.CONF.import_group('ml2', 'neutron.conf.plugins.ml2.config')
  File "/usr/local/lib/python2.7/dist-packages/oslo_config/cfg.py", line 2740, in import_group
    self._get_group(group)
  File "/usr/local/lib/python2.7/dist-packages/oslo_config/cfg.py", line 3076, in _get_group
    raise NoSuchGroupError(group_name)
oslo_config.cfg.NoSuchGroupError: no such group [ml2]

[OpenStack Infra (hudson-openstack)]

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

[daixianmeng (daixianmeng)]

In Pike,I execute this command no error:
[root@pike ~]# neutron-sanity-check
Guru meditation now registers SIGUSR1 and SIGUSR2 by default for backward compatibility. SIGUSR1 will no longer be registered in a future release, so please use SIGUSR2 to generate reports.
2018-05-10 11:16:42.973 13244 INFO neutron.common.config [-] Logging enabled!
2018-05-10 11:16:42.974 13244 INFO neutron.common.config [-] /usr/bin/neutron-sanity-check version 11.0.2

Are you install openstack-neutron-ml2 ?

[Brian Haley (brian-haley)]

This would only be in Queens in later since I think that's when we moved all the config options to a central location.

[Alan Meadows (alan-meadows)]

Does this mean there is no gating for this tool in neutron? It seems not.

A neutron-sanity-check has been a standard part of openstack-helm's neutron deployment since newton. It was discovered this no longer functions while seeking to support releases up to queens. We felt this added value that could raise issues to users early.

It is worrying that this wasn't noticed by other automation tools leaving us to wonder if we are the only ones using it and whether its safe to continue to do so going forward. In addition to the actual fix, there has to be some assurance we can rely on this to to be maintained going forward.

[Miguel Lavalle (minsel)]

@Alan,

Please see my comment here: https://review.openstack.org/#/c/566961/1. There I explain why our unit test, which we run for every patch in the CI system, didn't catch the bug. I also suggest how to modify the unit test to prevent this from happening again

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/566961
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=db22f5bfa81df10ce4a30cae725b6e11c843ee30
Submitter: Zuul
Branch: master

commit db22f5bfa81df10ce4a30cae725b6e11c843ee30
Author: Brian Haley <email address hidden>
Date: Tue May 8 14:06:30 2018 -0400

    Fix exception in neutron-sanity-check

    When the config options were all moved to neutron/conf
    the neutron-sanity-check script was not updated. Have
    it use the registration methods directly.

    Change-Id: Ie45ce0faa17ee4cfe8d2a1dce442b032efea0041
    Closes-bug: #1769868

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 13.0.0.0b3 development milestone.