Adding tests for IPv6.
[snaps.git] / docs / how-to-use / APITests.rst
index 9110162..f71426c 100644 (file)
@@ -163,22 +163,63 @@ neutron_utils_tests.py - NeutronUtilsSubnetTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Neutron API   | Description                                               |
 +=======================================+===============+===========================================================+
-| test_create_subnet                    | 2             | Ensures neutron_utils.create_subnet() can properly create |
+| test_create_subnet                    | 2             | Ensures neutron_utils.create_network() can properly create|
 |                                       |               | an OpenStack subnet object                                |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_subnet_null_name          | 2             | Ensures neutron_utils.create_subnet() raises an exception |
+| test_create_subnet_null_name          | 2             | Ensures neutron_utils.create_network() raises an exception|
 |                                       |               | when the subnet name is None                              |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_subnet_empty_name         | 2             | Ensures neutron_utils.create_subnet() raises an exception |
+| test_create_subnet_empty_name         | 2             | Ensures neutron_utils.create_network() raises an exception|
 |                                       |               | when the subnet name is an empty string                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_subnet_null_cidr          | 2             | Ensures neutron_utils.create_subnet() raises an exception |
+| test_create_subnet_null_cidr          | 2             | Ensures neutron_utils.create_network() raises an exception|
 |                                       |               | when the subnet CIDR is None                              |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_subnet_empty_cidr         | 2             | Ensures neutron_utils.create_subnet() raises an exception |
+| test_create_subnet_empty_cidr         | 2             | Ensures neutron_utils.create_network() raises an exception|
 |                                       |               | when the subnet CIDR is an empty string                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
+neutron_utils_tests.py - NeutronUtilsIPv6Tests
+----------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Neutron API   | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_network_slaac             | 2             | Ensures neutron_utils.create_network() can properly create|
+|                                       |               | an OpenStack network with an IPv6 subnet when DHCP is True|
+|                                       |               | and modes are 'slaac'                                     |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_stateful          | 2             | Ensures neutron_utils.create_network() can properly create|
+|                                       |               | an OpenStack network with an IPv6 subnet when DHCP is True|
+|                                       |               | and modes are 'stateful'                                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_stateless         | 2             | Ensures neutron_utils.create_network() can properly create|
+|                                       |               | an OpenStack network with an IPv6 subnet when DHCP is True|
+|                                       |               | and modes are 'stateless'                                 |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_no_dhcp_slaac     | 2             | Ensures neutron_utils.create_network() raises a BadRequest|
+|                                       |               | exception when deploying the network with an IPv6 subnet  |
+|                                       |               | when DHCP is False and modes are 'slaac'                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_invalid_start_ip  | 2             | Ensures neutron_utils.create_network() sets the start IP  |
+|                                       |               | address to the minimum value when the start configuration |
+|                                       |               | parameter is some garbage value                           |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_invalid_end_ip    | 2             | Ensures neutron_utils.create_network() sets the end IP    |
+|                                       |               | address to the maximum value when the end configuration   |
+|                                       |               | parameter is some garbage value                           |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_with_bad_cidr     | 2             | Ensures neutron_utils.create_network() raises a BadRequest|
+|                                       |               | exception when the IPv6 CIDR is incorrect                 |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_invalid_gateway_ip| 2             | Ensures neutron_utils.create_network() raises a BadRequest|
+|                                       |               | exception when the IPv6 gateway IP does not match the CIDR|
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_network_with_bad_dns      | 2             | Ensures neutron_utils.create_network() raises a BadRequest|
+|                                       |               | exception when the IPv6 DNS IP address is not a valid IPv6|
+|                                       |               | address                                                   |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
 neutron_utils_tests.py - NeutronUtilsRouterTests
 ------------------------------------------------
 
@@ -192,12 +233,6 @@ neutron_utils_tests.py - NeutronUtilsRouterTests
 | face                                  |               | an OpenStack router object with an interface to the       |
 |                                       |               | external network                                          |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_router_empty_name         | 2             | Ensures neutron_utils.create_router() raises an exception |
-|                                       |               | when the name is an empty string                          |
-+---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_router_null_name          | 2             | Ensures neutron_utils.create_router() raises an exception |
-|                                       |               | when the name is None                                     |
-+---------------------------------------+---------------+-----------------------------------------------------------+
 | test_add_interface_router             | 2             | Ensures neutron_utils.add_interface_router() properly adds|
 |                                       |               | an interface to another subnet                            |
 +---------------------------------------+---------------+-----------------------------------------------------------+
@@ -207,6 +242,9 @@ neutron_utils_tests.py - NeutronUtilsRouterTests
 | test_add_interface_router_null_subnet | 2             | Ensures neutron_utils.add_interface_router() raises an    |
 |                                       |               | exception when the subnet object is None                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+
+| test_add_interface_router_missing_sub | 2             | Ensures neutron_utils.add_interface_router() raises an    |
+| net                                   |               | exception when the subnet object had been deleted         |
++---------------------------------------+---------------+-----------------------------------------------------------+
 | test_create_port                      | 2             | Ensures neutron_utils.create_port() can properly create an|
 |                                       |               | OpenStack port object                                     |
 +---------------------------------------+---------------+-----------------------------------------------------------+
@@ -429,9 +467,9 @@ heat_utils_tests.py - HeatUtilsCreateSimpleStackTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
-| test_create_stack                     | 1             | Tests the heat_utils.create_stack() with a test template  |
+| test_create_stack                     | 1-3           | Tests the heat_utils.create_stack() with a test template  |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_stack_x2                  | 1             | Tests the heat_utils.create_stack() with a test template  |
+| test_create_stack_x2                  | 1-3           | Tests the heat_utils.create_stack() with a test template  |
 |                                       |               | and attempts to deploy a second time w/o actually         |
 |                                       |               | deploying any objects                                     |
 +---------------------------------------+---------------+-----------------------------------------------------------+
@@ -442,22 +480,33 @@ heat_utils_tests.py - HeatUtilsCreateComplexStackTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
-| test_get_settings_from_stack          | 1             | Tests the heat_utils functions that are responsible for   |
+| test_get_settings_from_stack          | 1-3           | Tests the heat_utils functions that are responsible for   |
 |                                       |               | reverse engineering settings objects of the types deployed|
 |                                       |               | by Heat                                                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
+heat_utils_tests.py - HeatUtilsRouterTests
+------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Heat API      | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_router_with_stack         | 1-3           | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_routers() to return the correct      |
+|                                       |               | OpenStackRouter instance                                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
 heat_utils_tests.py - HeatUtilsVolumeTests
 ------------------------------------------
 
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
-| test_create_vol_with_stack            | 1             | Tests ability of the function                             |
+| test_create_vol_with_stack            | 1-3           | Tests ability of the function                             |
 |                                       |               | heat_utils.create_stack() to return the correct           |
 |                                       |               | Volume domain objects deployed with Heat                  |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_vol_types_with_stack      | 1             | Tests ability of the function                             |
+| test_create_vol_types_with_stack      | 1-3           | Tests ability of the function                             |
 |                                       |               | heat_utils.get_stack_volumes_types() to return the correct|
 |                                       |               | VolumeType domain objects deployed with Heat              |
 +---------------------------------------+---------------+-----------------------------------------------------------+
@@ -468,11 +517,33 @@ heat_utils_tests.py - HeatUtilsKeypairTests
 +---------------------------------------+---------------+-----------------------------------------------------------+
 | Test Name                             | Heat API      | Description                                               |
 +=======================================+===============+===========================================================+
-| test_create_keypair_with_stack        | 1             | Tests ability of the function                             |
-|                                       |               | heat_utils.create_stack() to return the correct           |
+| test_create_keypair_with_stack        | 1-3           | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_keypairs() to return the correct     |
 |                                       |               | Keypair domain objects deployed with Heat                 |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
+heat_utils_tests.py - HeatUtilsSecurityGroupTests
+-------------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Heat API      | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_security_group_with_stack | 1-3           | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_security_groups() to return the      |
+|                                       |               | correct SecurityGroup domain objects deployed with Heat   |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
+heat_utils_tests.py - HeatUtilsFlavorTests
+------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Heat API      | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_flavor_with_stack         | 1-3           | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_flavors() to return the correct      |
+|                                       |               | Flavor domain objects deployed with Heat                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
 settings_utils_tests.py - SettingsUtilsNetworkingTests
 ------------------------------------------------------