← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1817915] [NEW] Autogeneration of API sample docs fails

 

Public bug reported:

Running "tox -e api-samples" to generate api sample docs fails after
this change: https://review.openstack.org/#/c/634600/ because its
missing the corresponding doc/api_samples files for
nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.68
/server-evacuate-req.json.tpl and
nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.68
/server-evacuate-find-host-req.json.tpl.

The error message is as follows:

nova.tests.functional.api_sample_tests.test_evacuate.EvacuateJsonTestV268.test_server_evacuate_find_host(v2_68)
---------------------------------------------------------------------------------------------------------------

Captured traceback:
~~~~~~~~~~~~~~~~~~~
    b'Traceback (most recent call last):'
    b'  File "/opt/stack/nova/.tox/api-samples/lib/python3.5/site-packages/mock/mock.py", line 1305, in patched'
    b'    return func(*args, **keywargs)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 128, in test_server_evacuate_find_host'
    b'    server_resp=None, expected_resp_code=200)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 58, in _test_evacuate'
    b'    server_req, req_subs)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 525, in _do_post'
    b'    self._write_sample(name, body)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 140, in _write_sample'
    b"    name, self.microversion), 'w') as outf:"
    b"FileNotFoundError: [Errno 2] No such file or directory: '/opt/stack/nova/doc/api_samples/os-evacuate/v2.68/server-evacuate-find-host-req.json'"
    b''

nova.tests.functional.api_sample_tests.test_evacuate.EvacuateJsonTestV268.test_server_evacuate(v2_68)
-----------------------------------------------------------------------------------------------------

Captured traceback:
~~~~~~~~~~~~~~~~~~~
    b'Traceback (most recent call last):'
    b'  File "/opt/stack/nova/.tox/api-samples/lib/python3.5/site-packages/mock/mock.py", line 1305, in patched'
    b'    return func(*args, **keywargs)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 202, in test_server_evacuate'
    b'    server_resp=None, expected_resp_code=200)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 58, in _test_evacuate'
    b'    server_req, req_subs)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 525, in _do_post'
    b'    self._write_sample(name, body)'
    b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 140, in _write_sample'
    b"    name, self.microversion), 'w') as outf:"
    b"FileNotFoundError: [Errno 2] No such file or directory: '/opt/stack/nova/doc/api_samples/os-evacuate/v2.68/server-evacuate-req.json'"
    b''


What is strange is that this was not detected as failing in the CIs which means there is no gate job running tox -e api-samples for API changes which should also be added I guess.

** Affects: nova
     Importance: Undecided
     Assignee: Surya Seetharaman (tssurya)
         Status: New


** Tags: api doc

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1817915

Title:
  Autogeneration of API sample docs fails

Status in OpenStack Compute (nova):
  New

Bug description:
  Running "tox -e api-samples" to generate api sample docs fails after
  this change: https://review.openstack.org/#/c/634600/ because its
  missing the corresponding doc/api_samples files for
  nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.68
  /server-evacuate-req.json.tpl and
  nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.68
  /server-evacuate-find-host-req.json.tpl.

  The error message is as follows:

  nova.tests.functional.api_sample_tests.test_evacuate.EvacuateJsonTestV268.test_server_evacuate_find_host(v2_68)
  ---------------------------------------------------------------------------------------------------------------

  Captured traceback:
  ~~~~~~~~~~~~~~~~~~~
      b'Traceback (most recent call last):'
      b'  File "/opt/stack/nova/.tox/api-samples/lib/python3.5/site-packages/mock/mock.py", line 1305, in patched'
      b'    return func(*args, **keywargs)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 128, in test_server_evacuate_find_host'
      b'    server_resp=None, expected_resp_code=200)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 58, in _test_evacuate'
      b'    server_req, req_subs)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 525, in _do_post'
      b'    self._write_sample(name, body)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 140, in _write_sample'
      b"    name, self.microversion), 'w') as outf:"
      b"FileNotFoundError: [Errno 2] No such file or directory: '/opt/stack/nova/doc/api_samples/os-evacuate/v2.68/server-evacuate-find-host-req.json'"
      b''

  nova.tests.functional.api_sample_tests.test_evacuate.EvacuateJsonTestV268.test_server_evacuate(v2_68)
  -----------------------------------------------------------------------------------------------------

  Captured traceback:
  ~~~~~~~~~~~~~~~~~~~
      b'Traceback (most recent call last):'
      b'  File "/opt/stack/nova/.tox/api-samples/lib/python3.5/site-packages/mock/mock.py", line 1305, in patched'
      b'    return func(*args, **keywargs)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 202, in test_server_evacuate'
      b'    server_resp=None, expected_resp_code=200)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_sample_tests/test_evacuate.py", line 58, in _test_evacuate'
      b'    server_req, req_subs)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 525, in _do_post'
      b'    self._write_sample(name, body)'
      b'  File "/opt/stack/nova/nova/tests/functional/api_samples_test_base.py", line 140, in _write_sample'
      b"    name, self.microversion), 'w') as outf:"
      b"FileNotFoundError: [Errno 2] No such file or directory: '/opt/stack/nova/doc/api_samples/os-evacuate/v2.68/server-evacuate-req.json'"
      b''

  
  What is strange is that this was not detected as failing in the CIs which means there is no gate job running tox -e api-samples for API changes which should also be added I guess.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1817915/+subscriptions


Follow ups