unified paremeters parse and resource_id->name

Author: 0lvin

README.md

@@ -46,6 +46,7 @@ Description for VM
 * `resource_id`: (optional) Used to identify the object when
   `use_external_resource` is true.
 * `params`: params used for create object, useful for embeded template.
+  * `name`: Domain name
   * `vcpu`: CPU count
   * `memory_size`: VM memory size in KiB
   * `memory_maxsize`: (optional) recomended VM memory size in KiB for
@@ -80,6 +81,7 @@ Description for Network
 * `resource_id`: (optional) Used to identify the object when
   `use_external_resource` is true.
 * `params`: params used for create object.
+  * `name`: Network name
   * `dev`: Device name
   * `forwards`: settings for network `forwards`.
   * `ips`: settings for network `ips`.

cloudify_libvirt/common.py

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import os
+import uuid
 from jinja2 import Template
 from pkg_resources import resource_filename
 
@@ -35,6 +36,12 @@ def get_libvirt_params(**kwargs):
     template_params.update(kwargs.get('params', {}))
     ctx.instance.runtime_properties['params'] = template_params
 
+    # set default names and instance_uuid
+    if not template_params.get("name"):
+        template_params["name"] = ctx.instance.id
+    if not template_params.get("instance_uuid"):
+        template_params["instance_uuid"] = str(uuid.uuid4())
+
     # update 'resource_id', 'use_external_resource' from kwargs
     for field in ['resource_id', 'use_external_resource']:
         if field in kwargs:

cloudify_libvirt/domain_tasks.py

@@ -15,7 +15,6 @@
 
 import libvirt
 import time
-import uuid
 
 from cloudify import ctx
 from cloudify.decorators import operation
@@ -33,22 +32,14 @@ def create(**kwargs):
 
 def _update_template_params(template_params):
     # set all params to default values
-    if not template_params:
-        template_params = {}
-
-    if not template_params.get("resource_id"):
-        template_params["resource_id"] = ctx.instance.id
     if (not template_params.get("memory_maxsize") and
             template_params.get('memory_size')):
         # if have no maximum memory size, set current as minimum
         # and twised memory as maximum
         memory_size = int(template_params['memory_size'])
         template_params['memory_maxsize'] = memory_size * 2
-    if not template_params.get("instance_uuid"):
-        template_params["instance_uuid"] = str(uuid.uuid4())
     if not template_params.get("domain_type"):
         template_params["domain_type"] = "qemu"
-    return template_params
 
 
 @operation
@@ -62,8 +53,7 @@ def configure(**kwargs):
             'Failed to open connection to the hypervisor'
         )
 
-    template_params = _update_template_params(template_params)
-
+    _update_template_params(template_params)
     try:
         if ctx.instance.runtime_properties.get("use_external_resource"):
             # lookup the default domain by name

cloudify_libvirt/network_tasks.py

@@ -14,7 +14,6 @@
 # limitations under the License.
 
 import libvirt
-import uuid
 import time
 
 from cloudify import ctx
@@ -23,21 +22,6 @@
 import cloudify_libvirt.common as common
 
 
-def _update_template_params(template_params):
-    # set all params to default values
-    if not template_params:
-        template_params = {}
-
-    if not template_params:
-        template_params = {}
-
-    if not template_params.get("resource_id"):
-        template_params["resource_id"] = ctx.instance.id
-    if not template_params.get("instance_uuid"):
-        template_params["instance_uuid"] = str(uuid.uuid4())
-    return template_params
-
-
 @operation
 def create(**kwargs):
     ctx.logger.info("Creating new network.")
@@ -49,8 +33,6 @@ def create(**kwargs):
             'Failed to open connection to the hypervisor'
         )
 
-    template_params = _update_template_params(template_params)
-
     try:
         if ctx.instance.runtime_properties.get("use_external_resource"):
             # lookup the default network by name

cloudify_libvirt/templates/domain.xml

@@ -2,6 +2,7 @@
   <resource>
     <partition>/machine</partition>
   </resource>
+  <name>{{ name }}</name>
   <uuid>{{ instance_uuid }}</uuid>
   <currentMemory unit="KiB">{{ memory_size }}</currentMemory>
   <on_poweroff>destroy</on_poweroff>
@@ -67,5 +68,4 @@
     <timer name="pit" tickpolicy="delay"/>
     <timer name="hpet" present="no"/>
   </clock>
-  <name>{{ resource_id }}</name>
 </domain>

cloudify_libvirt/templates/network.xml

@@ -1,5 +1,5 @@
 <network>
-  <name>{{ resource_id }}</name>
+  <name>{{ name }}</name>
   <uuid>{{ instance_uuid }}</uuid>
   <bridge name="{{ dev }}" />
   {% for forward in forwards %}

cloudify_libvirt/tests/test_common.py

@@ -34,10 +34,18 @@ def test_get_libvirt_params(self):
         )
         current_ctx.set(_ctx)
 
-        self.assertEqual(common.get_libvirt_params(), (None, {}))
+        with mock.patch(
+            "cloudify_libvirt.common.uuid.uuid4",
+            mock.Mock(return_value="some_uuid")
+        ):
+            self.assertEqual(common.get_libvirt_params(),
+                             (None, {'name': 'node_name',
+                                     'instance_uuid': 'some_uuid'}))
+
         self.assertEqual(_ctx.instance.runtime_properties, {
             'libvirt_auth': None,
-            'params': {}
+            'params': {'name': 'node_name',
+                       'instance_uuid': 'some_uuid'}
         })
 
         # overwrite
@@ -54,21 +62,32 @@ def test_get_libvirt_params(self):
         )
         current_ctx.set(_ctx)
 
-        self.assertEqual(common.get_libvirt_params(
-            params={'z': 'y'}, libvirt_auth={'w': 'x'}
-        ), ({
-                'w': 'x'
-            }, {
-                'a': 'b',
-                'c': 'd',
-                'e': 'g',
-                'z': 'y'
-            })
-        )
+        with mock.patch(
+            "cloudify_libvirt.common.uuid.uuid4",
+            mock.Mock(return_value="some_uuid")
+        ):
+            self.assertEqual(common.get_libvirt_params(
+                params={'z': 'y'}, libvirt_auth={'w': 'x'}
+            ), ({
+                    'w': 'x'
+                }, {
+                    # default values
+                    'instance_uuid': 'some_uuid',
+                    'name': 'node_name',
+                    # combined
+                    'a': 'b',
+                    'c': 'd',
+                    'e': 'g',
+                    'z': 'y'
+                })
+            )
         self.assertEqual(_ctx.instance.runtime_properties, {
             'libvirt_auth': {'w': 'x'},
-            'params': {'a': 'b', 'c': 'd', 'e': 'g', 'z': 'y'}
-        })
+            'params': {
+                # default values
+                'instance_uuid': 'some_uuid', 'name': 'node_name',
+                # combined
+                'a': 'b', 'c': 'd', 'e': 'g', 'z': 'y'}})
 
     def test_save_node_state(self):
         isdir = mock.Mock(return_value=False)

cloudify_libvirt/tests/test_domain.py

@@ -81,11 +81,18 @@ def test_create(self):
         real logic"""
         _ctx = self._create_ctx()
 
-        domain_tasks.create(ctx=_ctx, params={'z': 'y'},
-                            libvirt_auth={'w': 'x'})
+        with mock.patch(
+            "cloudify_libvirt.common.uuid.uuid4",
+            mock.Mock(return_value="some_uuid")
+        ):
+            domain_tasks.create(ctx=_ctx, params={'z': 'y'},
+                                libvirt_auth={'w': 'x'})
         self.assertEqual(_ctx.instance.runtime_properties, {
             'libvirt_auth': {'w': 'x'},
             'params': {
+                # default values
+                'name': 'node_name', 'instance_uuid': 'some_uuid',
+                # values from inputs
                 'a': 'b', 'c': 'd', 'e': 'g', 'z': 'y'
             }
         })

examples/cluster.yaml

@@ -115,7 +115,7 @@ node_templates:
         create:
           inputs:
             params:
-              resource_id: manager_network
+              name: manager_network
               dev: virbr9
               forwards:
                 - mode: nat

plugin.yaml

@@ -9,6 +9,11 @@ data_types:
 
   network_params:
     properties:
+      name:
+        required: false
+        default: ""
+        description: >
+          Network name
       dev:
         required: false
         default: ""
@@ -27,6 +32,11 @@ data_types:
 
   domain_params:
     properties:
+      name:
+        required: false
+        default: ""
+        description: >
+          Domain name
       vcpu:
         required: false
         type: integer