nova/nova/tests/functional/api_sample_tests
Stephen Finucane 1b71252a5f Remove (most) '/os-networks' REST APIs
Drop support for most of the 'os-networks' REST APIs excluding those
that proxy through to neutron.

This API now returns a 410 response for the non-proxy routes.

Unit tests are removed for removed APIs and the functional API sample
tests are just asserting the 410 response now same. The latter are also
expanded to cover APIs that weren't previously tested.

The API sample docs are left intact since the API reference still builds
from those and can be considered more or less branchless, so people
looking at the API reference can apply it to older deployments of nova
before these APIs were removed.

Note: yes, the API samples are correct. It really is a useless API when
used with neutron.

Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-18 16:25:47 +00:00
..
api_samples Remove (most) '/os-networks' REST APIs 2019-11-18 16:25:47 +00:00
README.rst add api-samples tox target 2015-12-03 22:43:26 +00:00
__init__.py
api_sample_base.py nova-net: Add TODOs for remaining nova-network functional tests 2019-11-18 16:25:47 +00: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: Migrate 'test_attach_interfaces' functional tests 2019-10-04 15:45:05 +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 Bump to hacking 1.1.0 2019-04-12 16:23:49 +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 unused request API sample template 2018-08-03 07:00:13 +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 Fixes to get all functional tests working on py35 2017-01-14 13:06:56 -05:00
test_flavor_manage.py Multiple API cleanup changes 2019-08-12 08:52:38 -05:00
test_flavors.py Multiple API cleanup changes 2019-08-12 08:52:38 -05: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: Migrate 'test_floating_ip_pools' functional tests 2019-10-03 21:04:52 +00:00
test_floating_ips.py nova-net: Use deepcopy on value returned by NeutronFixture 2019-10-11 16:01:17 +01:00
test_floating_ips_bulk.py Remove support for /os-floating-ips-bulk REST API 2018-07-18 22:23:45 -04: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 Resource retrieving: add changes-before filter 2018-09-19 09:56:56 -04:00
test_instance_usage_audit_log.py Fix invalid import order 2016-07-04 11:23:52 +05:30
test_keypairs.py Use uuidsentinel from oslo.utils 2018-09-05 09:08:54 -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 nova-net: Remove explicit 'USE_NEUTRON = True' 2019-10-02 15:14:01 +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 Remove (most) '/os-networks' REST APIs 2019-11-18 16:25:47 +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 hacking: Resolve W605 (invalid escape sequence) 2019-06-24 14:24:06 -05:00
test_rescue.py nova-net: Migrate 'test_rescue' functional tests 2019-10-04 15:44:48 +00: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: Remove explicit 'USE_NEUTRON = True' 2019-10-02 15:14:01 +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 Execute CrossCellMigrationTask from MigrationTask 2019-11-05 14:16:03 -05: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 Stop using NoAuthMiddleware in tests 2019-10-14 11:43:52 -05: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 nova-net: Add TODOs for remaining nova-network functional tests 2019-11-18 16:25:47 +00:00
test_versions.py Stop using NoAuthMiddleware in tests 2019-10-14 11:43:52 -05:00
test_virtual_interfaces.py Use uuidsentinel from oslo.utils 2018-09-05 09:08:54 -05:00
test_volumes.py Use multiple attachments in test_list_volume_attachments 2019-09-11 17:44:36 -04: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.