Merge pull request #256 from cloudify-cosmo/2.9.6-build

fix external volume availability zone issue

Author: EarthmanT

.gitignore

@@ -62,3 +62,4 @@ docs/_build/
 
 .idea/
 
+.DS_Store

CHANGELOG.txt

@@ -1,3 +1,4 @@
+2.9.6: Correctly set the availability zone runtime property when using an external volume.
 2.9.5: Creating servers with multiple security groups.
 2.9.4: Backporting change from 3.0.0 dev branch.
 2.9.3: Improve Host Aggregate members handling.

README.md

@@ -9,3 +9,22 @@ Cloudify OpenStack Plugin
 ## Usage
 
 See [Openstack Plugin](https://docs.cloudify.co/latest/developer/official_plugins/openstack/)
+
+
+## Known Issues
+
+You may experience such an error when using a local profile:
+
+```shell
+ERROR:cloudify.cli.main:(PyYAML 3.10 (/.../python2.7/site-packages), Requirement.parse('PyYAML>=3.12'), set(['oslo.config']))
+```
+
+Cloudify CLI requires PyYAML 3.10, whereas Openstack Python SDK Libraries require PyYAML 3.12. For this reason, if you wish to use Cloudify Openstack Plugin in a local profile, you will need to upgrade the PyYAML 3.12 in your virtualenv.
+
+Fix:
+
+```shell
+pip install -U pyyaml==3.12
+```
+
+At this stage, you should no longer use the flag `--install-plugins` with the `cfy` CLI.

cinder_plugin/tests/test_volume.py

@@ -21,7 +21,8 @@
 from cloudify.state import current_ctx
 from cinder_plugin import volume
 from nova_plugin import server
-from openstack_plugin_common import (OPENSTACK_ID_PROPERTY,
+from openstack_plugin_common import (OPENSTACK_AZ_PROPERTY,
+                                     OPENSTACK_ID_PROPERTY,
                                      OPENSTACK_TYPE_PROPERTY,
                                      OPENSTACK_NAME_PROPERTY,
                                      OPENSTACK_RESOURCE_PROPERTY)
@@ -93,6 +94,7 @@ def test_create_use_existing(self):
         existing_volume_m = mock.Mock()
         existing_volume_m.id = volume_id
         existing_volume_m.status = volume.VOLUME_STATUS_AVAILABLE
+        existing_volume_m.availability_zone = 'az'
         cinder_client_m = mock.Mock()
         cinder_client_m.volumes = mock.Mock()
         cinder_client_m.volumes.create = mock.Mock()
@@ -112,6 +114,9 @@ def test_create_use_existing(self):
         self.assertEqual(
             volume.VOLUME_OPENSTACK_TYPE,
             ctx_m.instance.runtime_properties[OPENSTACK_TYPE_PROPERTY])
+        self.assertEqual(
+            ctx_m.instance.runtime_properties[OPENSTACK_AZ_PROPERTY],
+            'az')
         self.assertTrue(
             ctx_m.instance.runtime_properties[OPENSTACK_RESOURCE_PROPERTY]
         )

cinder_plugin/volume.py

@@ -47,16 +47,28 @@
 DEVICE_NAME_PROPERTY = 'device_name'
 
 VOLUME_OPENSTACK_TYPE = 'volume'
+VOLUME_OPENSTACK_ID_KEY = 'name'
 
 RUNTIME_PROPERTIES_KEYS = COMMON_RUNTIME_PROPERTIES_KEYS
 
 
+def _set_volume_runtime_properties(volume):
+    try:
+        ctx.instance.runtime_properties[OPENSTACK_AZ_PROPERTY] = \
+            volume.availability_zone
+    except AttributeError:
+        ctx.logger.error('Volume availability_zone not found.')
+
+
 @operation
 @with_cinder_client
 def create(cinder_client, status_attempts, status_timeout, args, **kwargs):
 
-    if use_external_resource(ctx, cinder_client, VOLUME_OPENSTACK_TYPE,
-                             'name'):
+    external_volume = use_external_resource(
+        ctx, cinder_client, VOLUME_OPENSTACK_TYPE, VOLUME_OPENSTACK_ID_KEY)
+
+    if external_volume:
+        _set_volume_runtime_properties(external_volume)
         return
 
     volume_dict = create_object_dict(ctx, VOLUME_OPENSTACK_TYPE, args, {})
@@ -68,15 +80,14 @@ def create(cinder_client, status_attempts, status_timeout, args, **kwargs):
     ctx.instance.runtime_properties[OPENSTACK_TYPE_PROPERTY] = \
         VOLUME_OPENSTACK_TYPE
     ctx.instance.runtime_properties[OPENSTACK_NAME_PROPERTY] = \
-        volume_dict['name']
+        volume_dict[VOLUME_OPENSTACK_ID_KEY]
     wait_until_status(cinder_client=cinder_client,
                       volume_id=v.id,
                       status=VOLUME_STATUS_AVAILABLE,
                       num_tries=status_attempts,
                       timeout=status_timeout,
                       )
-    ctx.instance.runtime_properties[OPENSTACK_AZ_PROPERTY] = \
-        v.availability_zone
+    _set_volume_runtime_properties(v)
 
 
 def _delete_snapshot(cinder_client, search_opts):
@@ -115,8 +126,8 @@ def _delete_backup(cinder_client, search_opts):
         return
 
     for backup in backups:
-        if search_opts.get('name'):
-            if backup.name != search_opts['name']:
+        if search_opts.get(VOLUME_OPENSTACK_ID_KEY):
+            if backup.name != search_opts[VOLUME_OPENSTACK_ID_KEY]:
                 continue
             ctx.logger.debug("Check backup before delete: {}:{} with state {}"
                              .format(backup.id, backup.name, backup.status))
@@ -131,8 +142,8 @@ def _delete_backup(cinder_client, search_opts):
     for backup in backups:
         ctx.logger.debug("Check backup after delete: {}:{} with state {}"
                          .format(backup.id, backup.name, backup.status))
-        if search_opts.get('name'):
-            if backup.name == search_opts['name']:
+        if search_opts.get(VOLUME_OPENSTACK_ID_KEY):
+            if backup.name == search_opts[VOLUME_OPENSTACK_ID_KEY]:
                 return ctx.operation.retry(
                     message='{} is still alive'.format(backup.name),
                     retry_after=30)
@@ -214,7 +225,7 @@ def snapshot_apply(cinder_client, **kwargs):
         ctx.logger.info("Backup apply {} to {}".format(backup_name, volume_id))
         search_opts = {
             'volume_id': volume_id,
-            'name': backup_name
+            VOLUME_OPENSTACK_ID_KEY: backup_name
         }
 
         backups = cinder_client.backups.list(
@@ -245,7 +256,7 @@ def snapshot_delete(cinder_client, **kwargs):
         # search snaphot for delete
         search_opts = {
             'volume_id': volume_id,
-            'name': backup_name
+            VOLUME_OPENSTACK_ID_KEY: backup_name
         }
         _delete_backup(cinder_client, search_opts)
     else:
@@ -263,7 +274,7 @@ def snapshot_delete(cinder_client, **kwargs):
 @with_cinder_client
 def creation_validation(cinder_client, **kwargs):
     validate_resource(ctx, cinder_client, VOLUME_OPENSTACK_TYPE,
-                      'name')
+                      VOLUME_OPENSTACK_ID_KEY)
 
 
 @operation

nova_plugin/server.py

@@ -226,15 +226,15 @@ def _handle_boot_volume(server, ctx):
     if boot_volume:
         boot_volume_id = boot_volume.runtime_properties[OPENSTACK_ID_PROPERTY]
         ctx.logger.info('boot_volume_id: {0}'.format(boot_volume_id))
-        az = boot_volume.runtime_properties[OPENSTACK_AZ_PROPERTY]
         # If a block device mapping already exists we shouldn't overwrite it
         # completely
         bdm = server.setdefault('block_device_mapping', {})
         bdm['vda'] = '{0}:::0'.format(boot_volume_id)
         # Some nova configurations allow cross-az server-volume connections, so
         # we can't treat that as an error.
         if not server.get('availability_zone'):
-            server['availability_zone'] = az
+            server['availability_zone'] = \
+                boot_volume.runtime_properties[OPENSTACK_AZ_PROPERTY]
 
 
 @operation

plugin.yaml

@@ -5,9 +5,9 @@
 plugins:
   openstack:
     executor: central_deployment_agent
-    source: https://github.com/cloudify-cosmo/cloudify-openstack-plugin/archive/2.9.5.zip
+    source: https://github.com/cloudify-cosmo/cloudify-openstack-plugin/archive/2.9.6.zip
     package_name: cloudify-openstack-plugin
-    package_version: '2.9.5'
+    package_version: '2.9.6'
 
 data_types:
   cloudify.openstack.types.custom_configuration:

setup.py

@@ -19,7 +19,7 @@
 setup(
     zip_safe=True,
     name='cloudify-openstack-plugin',
-    version='2.9.5',
+    version='2.9.6',
     author='Cloudify',
     author_email='hello@cloudify.co',
     packages=[

tox.ini

@@ -24,13 +24,6 @@ commands =
     --cover-package=openstack_plugin_common openstack_plugin_common/tests \
     --with-xunit --xunit-file=nosetests.xml
 
-[testenv:docs]
-changedir=docs
-deps =
-    git+https://github.com/cloudify-cosmo/sphinxify.git@initial-work
-commands =
-    sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
-
 [testenv:flake8]
 deps =
     flake8