Return OpenStackVolume and OpenStackVolumeType instances from heat.

Added a methods to OpenStackHeatStack to return any OpenStackVolume
and OpenStackVolumeType objects it was responsible for spawning.
Changes include all of the necessary changes to the heat and
settings utilities and associated tests.

JIRA: SNAPS-199, SNAPS-200

Change-Id: I6da4bce1e90f080e22c96ab1b46eca8b85991ebf
Signed-off-by: spisarski <s.pisarski@cablelabs.com>

3 files changed, 51 insertions, 12 deletions

diff --git a/docs/how-to-use/APITests.rst b/docs/how-to-use/APITests.rst
index 3ac272b..fbd7e67 100644
--- a/docs/how-to-use/APITests.rst
+++ b/docs/how-to-use/APITests.rst
@@ -447,6 +447,21 @@ heat_utils_tests.py - HeatUtilsCreateComplexStackTests
 |                                       |               | by Heat                                                   |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
+heat_utils_tests.py - HeatUtilsVolumeTests
+------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             | Heat API      | Description                                               |
++=======================================+===============+===========================================================+
+| test_create_vol_with_stack            | 1             | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_volumes() to return the correct      |
+|                                       |               | Volume domain objects deployed with Heat                  |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_create_vol_types_with_stack      | 1             | Tests ability of the function                             |
+|                                       |               | heat_utils.get_stack_volumes_types() to return the correct|
+|                                       |               | VolumeType domain objects deployed with Heat              |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
 settings_utils_tests.py - SettingsUtilsNetworkingTests
 ------------------------------------------------------
 
diff --git a/docs/how-to-use/IntegrationTests.rst b/docs/how-to-use/IntegrationTests.rst
index 5a734ef..538c9c0 100644
--- a/docs/how-to-use/IntegrationTests.rst
+++ b/docs/how-to-use/IntegrationTests.rst
@@ -360,34 +360,49 @@ create_stack_tests.py - CreateStackSuccessTests
 -----------------------------------------------
 
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| Test Name                             | Neutron API   | Description                                               |
+| Test Name                             |   Heat API    | Description                                               |
 +=======================================+===============+===========================================================+
-| test_create_stack_template_file       | 2             | Ensures that a Heat stack can be created with a file-based|
+| test_create_stack_template_file       | 1             | Ensures that a Heat stack can be created with a file-based|
 |                                       |               | Heat template file                                        |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_stack_template_dict       | 2             | Ensures that a Heat stack can be created with a dictionary|
+| test_create_stack_template_dict       | 1             | Ensures that a Heat stack can be created with a dictionary|
 |                                       |               | Heat template                                             |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_delete_stack              | 2             | Ensures that a Heat stack can be created and deleted      |
+| test_create_delete_stack              | 1             | Ensures that a Heat stack can be created and deleted      |
 |                                       |               | while having clean() called 2x without an exception       |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_create_same_stack                | 2             | Ensures that a Heat stack with the same name cannot be    |
+| test_create_same_stack                | 1             | Ensures that a Heat stack with the same name cannot be    |
 |                                       |               | created 2x                                                |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_retrieve_network_creators        | 2             | Ensures that an OpenStackHeatStack instance can return an |
+| test_retrieve_network_creators        | 1             | Ensures that an OpenStackHeatStack instance can return an |
 |                                       |               | OpenStackNetwork instance configured as deployed          |
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| test_retrieve_vm_inst_creators        | 2             | Ensures that an OpenStackHeatStack instance can return an |
+| test_retrieve_vm_inst_creators        | 1             | Ensures that an OpenStackHeatStack instance can return an |
 |                                       |               | OpenStackVmInstance instance configured as deployed       |
 +---------------------------------------+---------------+-----------------------------------------------------------+
 
+create_stack_tests.py - CreateStackVolumeTests
+----------------------------------------------
+
++---------------------------------------+---------------+-----------------------------------------------------------+
+| Test Name                             |   Heat API    | Description                                               |
++=======================================+===============+===========================================================+
+| test_retrieve_volume_creator          | 1             | Ensures that an OpenStackHeatStack instance can return a  |
+|                                       |               | OpenStackVolume instance that it was responsible for      |
+|                                       |               | deploying                                                 |
++---------------------------------------+---------------+-----------------------------------------------------------+
+| test_retrieve_volume_type_creator     | 1             | Ensures that an OpenStackHeatStack instance can return a  |
+|                                       |               | OpenStackVolumeType instance that it was responsible for  |
+|                                       |               | deploying                                                 |
++---------------------------------------+---------------+-----------------------------------------------------------+
+
 create_stack_tests.py - CreateComplexStackTests
 -----------------------------------------------
 
 +---------------------------------------+---------------+-----------------------------------------------------------+
-| Test Name                             | Neutron API   | Description                                               |
+| Test Name                             |   Heat API    | Description                                               |
 +=======================================+===============+===========================================================+
-| test_connect_via_ssh_heat_vm          | 2             | Ensures that two OpenStackHeatStack instances can return  |
+| test_connect_via_ssh_heat_vm          | 1             | Ensures that two OpenStackHeatStack instances can return  |
 |                                       |               | OpenStackVmInstance instances one configured with a       |
 |                                       |               | floating IP and keypair and can be access via SSH         |
 +---------------------------------------+---------------+-----------------------------------------------------------+
@@ -396,12 +411,12 @@ create_stack_tests.py - CreateStackNegativeTests
 ------------------------------------------------
 
 +----------------------------------------+---------------+-----------------------------------------------------------+
-| Test Name                              | Neutron API   | Description                                               |
+| Test Name                              |   Heat API    | Description                                               |
 +========================================+===============+===========================================================+
-| test_missing_dependencies              | 2             | Ensures that a Heat template fails to deploy when expected|
+| test_missing_dependencies              | 1             | Ensures that a Heat template fails to deploy when expected|
 |                                        |               | dependencies are missing                                  |
 +----------------------------------------+---------------+-----------------------------------------------------------+
-| test_bad_stack_file                    | 2             | Ensures that a Heat template fails to deploy when the Heat|
+| test_bad_stack_file                    | 1             | Ensures that a Heat template fails to deploy when the Heat|
 |                                        |               | template file does not exist                              |
 +----------------------------------------+---------------+-----------------------------------------------------------+
 
diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst
index f6f52b5..3cb26db 100644
--- a/docs/how-to-use/UnitTests.rst
+++ b/docs/how-to-use/UnitTests.rst
@@ -293,3 +293,12 @@ VmInstDomainObjectTests
 
 Ensures that all required members are included when constructing a
 VmInst domain object
+
+SettingsUtilsVolumeTests
+------------------------
+
+Ensures that the settings_utils.py#create_volume_settings() function properly
+maps a snaps.domain.Volume object correctly to a
+snaps.openstack.create_volume.VolumeSettings object as well as a
+snaps.domain.VolumeType object to a
+snaps.openstack.create_volume.VolumeSettings object