Doc build from tarball fails with eventlet==0.20.1

[Javier Peña]

When trying to build documentation for some OpenStack projects (seen so far in Manila, Cinder and Congress) using a tarball instead of a git clone, we get the following error:

  File ".venv/lib/python2.7/site-packages/pbr/builddoc.py", line 200, in run
    self._sphinx_run()
  File ".venv/lib/python2.7/site-packages/pbr/builddoc.py", line 155, in _sphinx_run
    freshenv=self.fresh_env, warningiserror=self.warning_is_error)
  File ".venv/lib/python2.7/site-packages/sphinx/application.py", line 199, in __init__
    self.setup_extension(extension)
  File ".venv/lib/python2.7/site-packages/sphinx/application.py", line 523, in setup_extension
    ext_meta = mod.setup(self)
  File ".venv/lib/python2.7/site-packages/oslosphinx/__init__.py", line 99, in setup
    cgit_link = _guess_cgit_link()
  File ".venv/lib/python2.7/site-packages/oslosphinx/__init__.py", line 28, in _guess_cgit_link
    ['git', 'config', '--local', '--get', 'remote.origin.url']
  File "/usr/lib64/python2.7/subprocess.py", line 575, in check_output
    raise CalledProcessError(retcode, cmd, output=output)
subprocess.CalledProcessError: Command '['git', 'config', '--local', '--get', 'remote.origin.url']' returned non-zero exit status 1

In theory, oslosphinx should catch the exception and ignore it due to [1], but subprocess is being monkey-patched with eventlet, and it fails.

This works fine with eventlet==0.19.0.

[1] https://github.com/openstack/oslosphinx/blob/master/oslosphinx/__init__.py#L27-L33

[Javier Peña (jpena-c)]

I have found this open bug for eventlet: https://github.com/eventlet/eventlet/issues/357

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/467548
Committed: https://git.openstack.org/cgit/openstack/oslosphinx/commit/?id=ef759e96d15562a696b59126089f4ab51e06bd6f
Submitter: Jenkins
Branch: master

commit ef759e96d15562a696b59126089f4ab51e06bd6f
Author: Javier Pena <email address hidden>
Date: Wed May 24 11:26:28 2017 +0200

    Fix doc build from tarball using eventlet>0.19.0

    When subprocess is monkey-patched using eventlet, trying to catch
    subprocess.CalledProcessError exception won't work [1]. This breaks
    doc build from a tarball, so let's catch all exceptions.

    [1] https://github.com/eventlet/eventlet/issues/357

    Change-Id: Ibcf535c6e4994a67fc3ec71631a81ecb91dd2845
    Closes-Bug: #1693148

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/oslosphinx 4.13.0 release.