openstack/placement
Code Issues Proposed changes
752765cfd6
placement/nova/tests/functional/api_sample_tests/README.rst
Sean Dague 237ceeae5b add api-samples tox target 
api-samples generation is no longer straight forward, now that tox is
blocking environment changes, and that PYTHONHASHSEED is randomized in
each run.

This creates a tox target to make it easy to generate the api-samples.

Change-Id: Ie88597fecee5ce81fb29ce2cfb73b15d60f3f389
2015-12-03 22:43:26 +00:00

948 B
Raw Blame History

Api Samples

This part of the tree contains templates for API samples. The documentation in doc/api_samples is completely autogenerated from the tests in this directory.

To add a new api sample, add tests for the common passing and failing cases in this directory for your extension, and modify test_samples.py for your tests.

Then run the following command:

tox -e api-samples

Which will create the files on doc/api_samples.

If new tests are added or the .tpl files are changed due to bug fixes, the samples must be regenerated so they are in sync with the templates, as there is an additional test which reloads the documentation and ensures that it's in sync.

Debugging sample generation

If a .tpl is changed, its matching .json must be removed else the samples won't be generated. If an entirely new extension is added, a directory for it must be created before its samples will be generated.