openstack
/
nova
Code Issues Proposed changes
nova/nova/tests/functional/api_sample_tests
History
Stephen Finucane 9069b2802f tests: Define constants in '_IntegratedTestBase' 
Use a slightly more consistent naming scheme for variables, including
documentation, and add some variables that should always be defined.

Change-Id: Id30e10eab6697e9543d432a8feb2f50d454b6ac8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
(cherry picked from commit c558b58619)
 		2020-07-31 14:02:57 +01:00
..
api_samples api: Introduce microverion 2.87 allowing boot from volume rescue 2020-04-09 08:39:36 +01:00
README.rst add api-samples tox target 2015-12-03 22:43:26 +00:00
__init__.py
…
api_sample_base.py tests: Define constants in '_IntegratedTestBase' 2020-07-31 14:02:57 +01:00
test_admin_actions.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_admin_password.py remove unnecessary conf imports 2018-03-09 14:30:10 -05:00
test_agents.py Use nova.db.api directly 2018-07-10 14:56:27 +00:00
test_aggregates.py Add image caching API for aggregates 2019-10-15 21:22:31 -04:00
test_assisted_volume_snapshots.py Fixes to get all functional tests working on py35 2017-01-14 13:06:56 -05:00
test_attach_interfaces.py nova-net: Remove layer of indirection in 'nova.network' 2020-01-15 14:57:49 +00:00
test_availability_zone.py nova-net: Migrate 'test_availability_zone' functional tests 2019-10-03 21:04:39 +00:00
test_baremetal_nodes.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_block_device_mapping_boot.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_cells.py Remove '/os-cells' REST APIs 2019-04-16 18:26:13 +01:00
test_compare_result.py tests: Define constants in '_IntegratedTestBase' 2020-07-31 14:02:57 +01:00
test_console_auth_tokens.py Reduce scope of 'path' query parameter to noVNC consoles 2019-09-27 13:50:52 +00:00
test_console_output.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_consoles.py Remove 'os-consoles' API 2019-11-22 16:09:36 +00:00
test_create_backup.py 2.45: Remove Location header from createImage and createBackup responses 2017-04-25 15:52:14 -04:00
test_deferred_delete.py Fixes to get all functional tests working on py35 2017-01-14 13:06:56 -05:00
test_evacuate.py nova-net: Remove explicit 'USE_NEUTRON = True' 2019-10-02 15:14:01 +00:00
test_extension_info.py policy: clean-up 2016-06-30 19:56:14 +00:00
test_fixed_ips.py Remove support for /os-fixed-ips REST API 2018-06-26 09:20:28 -04:00
test_flavor_access.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_flavor_extraspecs.py trivial: Use recognized extra specs in tests 2020-02-19 08:24:31 +00:00
test_flavor_manage.py Multiple API cleanup changes 2019-08-12 08:52:38 -05:00
test_flavors.py trivial: Use recognized extra specs in tests 2020-02-19 08:24:31 +00:00
test_floating_ip_dns.py Remove support for /os-floating-ip-dns REST API 2018-07-18 22:23:45 -04:00
test_floating_ip_pools.py nova-net: Remove use of legacy 'FloatingIP' object 2019-12-03 15:04:41 +00:00
test_floating_ips.py Handle neutron without the fip-port-details extension 2020-02-04 17:36:24 +00:00
test_floating_ips_bulk.py nova-net: Remove final references to nova-network 2020-01-08 13:54:12 +00:00
test_fping.py Remove support for /os-fping REST API 2018-05-10 15:26:13 -04:00
test_hosts.py nova-net: Migrate 'test_hosts' functional tests 2019-10-04 15:44:38 +00:00
test_hypervisors.py nova-net: Migrate 'test_hypervisors' functional tests 2019-10-04 15:44:57 +00:00
test_images.py remove unnecessary conf imports 2018-03-09 14:30:10 -05:00
test_instance_actions.py Add instance actions v284 samples test 2020-03-30 03:02:31 +00:00
test_instance_usage_audit_log.py Fix invalid import order 2016-07-04 11:23:52 +05:30
test_keypairs.py Add test coverage of existing keypairs policies 2020-04-09 20:16:41 -05:00
test_limits.py Deprecate file injection 2017-12-12 09:22:21 -05:00
test_lock_server.py Microversion 2.73: Support adding the reason behind a server lock 2019-05-11 21:48:27 +00:00
test_migrate_server.py nova-net: Remove explicit 'USE_NEUTRON = True' 2019-10-02 15:14:01 +00:00
test_migrations.py Filter migrations by user_id/project_id 2019-10-14 11:35:11 -07:00
test_multinic.py functional: Add unified '_build_server' helper function 2020-01-15 10:31:24 +00:00
test_multiple_create.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_networks.py nova-net: Remove layer of indirection in 'nova.network' 2020-01-15 14:57:49 +00:00
test_networks_associate.py Remove (most) '/os-networks' REST APIs 2019-11-18 16:25:47 +00:00
test_pause_server.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_preserve_ephemeral_rebuild.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_quota_classes.py Deprecate file injection 2017-12-12 09:22:21 -05:00
test_quota_sets.py nova-net: Migrate 'test_quota_sets' functional tests 2019-10-04 15:22:27 +00:00
test_remote_consoles.py tests: Use consistent URL regex substitution 2019-06-24 14:24:06 -05:00
test_rescue.py api: Introduce microverion 2.87 allowing boot from volume rescue 2020-04-09 08:39:36 +01:00
test_security_group_default_rules.py Remove 'os-security-group-default-rules' REST API 2019-11-18 16:25:47 +00:00
test_security_groups.py nova-net: Make the security group API a module 2019-11-29 11:17:06 +00:00
test_server_diagnostics.py Standardization of VM diagnostics info API. 2017-06-05 07:45:51 +00:00
test_server_external_events.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_server_groups.py Microversion 2.64 - Use new format policy in server group 2018-07-13 10:43:42 +08:00
test_server_metadata.py remove unnecessary conf imports 2018-03-09 14:30:10 -05:00
test_server_migrations.py Filter migrations by user_id/project_id 2019-10-14 11:35:11 -07:00
test_server_password.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_server_tags.py nova-net: Migrate 'test_server_tags' functional tests 2019-10-04 15:40:31 +00:00
test_server_topology.py Add server sub-resource topology API 2019-08-30 10:04:56 +08:00
test_servers.py nova-net: Remove use of legacy 'FloatingIP' object 2019-12-03 15:04:41 +00:00
test_servers_ips.py trivial: Make it obvious where we're getting our names from 2019-10-05 15:40:28 +01:00
test_services.py Sync COMPUTE_STATUS_DISABLED from API 2019-07-02 18:57:38 -04:00
test_shelve.py nova-net: Remove explicit 'USE_NEUTRON = True' 2019-10-02 15:14:01 +00:00
test_simple_tenant_usage.py tests: Define constants in '_IntegratedTestBase' 2020-07-31 14:02:57 +01:00
test_suspend_server.py Enable all extension for all remaining sample tests 2016-06-10 06:03:02 +00:00
test_tenant_networks.py Remove '/os-tenant-networks' REST API 2019-11-22 16:03:11 +00:00
test_versions.py tests: Define constants in '_IntegratedTestBase' 2020-07-31 14:02:57 +01:00
test_virtual_interfaces.py Use uuidsentinel from oslo.utils 2018-09-05 09:08:54 -05:00
test_volumes.py Allow PUT volume attachments API to modify delete_on_termination 2020-04-02 09:26:55 -07:00

README.rst

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.