Merge pull request #5 from cloudify-incubator/network_reuse

Network reuse support

Author: 0lvin

README.md

@@ -54,6 +54,12 @@ Description for Network
 **Supported properties:**
 * `libvirt_auth`: connection url, by default: `qemu:///system`
 * `backup_dir`: directory for save backups, by default: `./`
+* `params`: params used for create object.
+  * `use_external_resource`: (optional) Use external object. The default is `false`.
+  * `resource_id`: (optional) Used to identify the object when `use_external_resource` is true.
+  * `dev`: Device name
+  * `forwards`: settings for network `forwards`.
+  * `ips`: settings for network `ips`.
 
 **Inputs for actions:**
 * `create`:

cloudify_libvirt/domain_tasks.py

@@ -75,6 +75,8 @@ def configure(**kwargs):
         template_params['memory_size'] = 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"
 
     params = {"ctx": ctx}
     params.update(template_params)

cloudify_libvirt/network_tasks.py

@@ -36,7 +36,30 @@ def create(**kwargs):
             'Failed to open connection to the hypervisor'
         )
 
+    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())
+
     try:
+        if template_params.get("use_external_resource"):
+            # lookup the default network by name
+            network = conn.networkLookupByName(template_params["resource_id"])
+            if network is None:
+                raise cfy_exc.NonRecoverableError(
+                    'Failed to find the network'
+                )
+
+            # save settings
+            ctx.instance.runtime_properties['params'] = template_params
+            ctx.instance.runtime_properties['resource_id'] = network.name()
+            ctx.instance.runtime_properties['use_external_resource'] = True
+            return
+
+        # templates
         network_file = kwargs.get('network_file')
         network_template = kwargs.get('network_template')
 
@@ -54,13 +77,6 @@ def create(**kwargs):
                 network_template = domain_desc.read()
 
         template_engine = Template(network_template)
-        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())
 
         params = {"ctx": ctx}
         params.update(template_params)
@@ -78,6 +94,7 @@ def create(**kwargs):
         ctx.logger.info('Params: ' + repr(template_params))
         ctx.instance.runtime_properties['params'] = template_params
         ctx.instance.runtime_properties['resource_id'] = network.name()
+        ctx.instance.runtime_properties['use_external_resource'] = False
 
         active = network.isActive()
         if active == 1:
@@ -97,6 +114,10 @@ def delete(**kwargs):
         ctx.logger.info("No network for delete")
         return
 
+    if ctx.instance.runtime_properties.get('use_external_resource'):
+        ctx.logger.info("External resource, skip")
+        return
+
     libvirt_auth, _ = common.get_libvirt_params(**kwargs)
     conn = libvirt.open(libvirt_auth)
     if conn is None:

cloudify_libvirt/templates/domain.xml

@@ -1,4 +1,4 @@
-<domain xmlns:qemu="http://libvirt.org/schemas/domain/qemu/1.0" xmlns="" type="qemu">
+<domain xmlns:qemu="http://libvirt.org/schemas/domain/qemu/1.0" xmlns="" type="{{ domain_type }}">
   <resource>
     <partition>/machine</partition>
   </resource>
@@ -61,6 +61,11 @@
     <type machine="pc" arch="x86_64">hvm</type>
     <boot dev="hd"/>
   </os>
-  <clock offset="utc"/>
+  <cpu mode="host-model"/>
+  <clock offset="utc">
+    <timer name="rtc" tickpolicy="catchup"/>
+    <timer name="pit" tickpolicy="delay"/>
+    <timer name="hpet" present="no"/>
+  </clock>
   <name>{{ resource_id }}</name>
 </domain>

cloudify_libvirt/tests/test_network.py

@@ -166,6 +166,52 @@ def _test_empty_network(self, func):
             "cloudify_libvirt.network_tasks.libvirt.open",
             func, [], {'ctx': _ctx}, 'resource')
 
+    def test_reuse_network_create_not_exist(self):
+        # check correct handle exception with empty network
+        _ctx = self._create_ctx()
+        self._check_no_such_object_network(
+            "cloudify_libvirt.network_tasks.libvirt.open",
+            network_tasks.create, [], {'ctx': _ctx, 'params': {
+                "resource_id": 'resource',
+                "use_external_resource": True,
+            }}, 'resource')
+
+    def test_reuse_network_create_exist(self):
+        # check that we can use network
+        _ctx = self._create_ctx()
+
+        network = mock.Mock()
+        network.name = mock.Mock(return_value="resource")
+
+        connect = self._create_fake_connection()
+        connect.networkLookupByName = mock.Mock(return_value=network)
+        with mock.patch(
+            "cloudify_libvirt.domain_tasks.libvirt.open",
+            mock.Mock(return_value=connect)
+        ):
+            network_tasks.create(ctx=_ctx, params={
+                    "resource_id": 'resource',
+                    "use_external_resource": True})
+        connect.networkLookupByName.assert_called_with('resource')
+        self.assertEqual(
+            _ctx.instance.runtime_properties['resource_id'], 'resource'
+        )
+        self.assertTrue(
+            _ctx.instance.runtime_properties['use_external_resource']
+        )
+
+    def _test_reused_network(self, func, use_existed=True):
+        # check use prexisted network
+        _ctx = self._create_ctx()
+        _ctx.instance.runtime_properties['resource_id'] = 'resource'
+        _ctx.instance.runtime_properties['use_external_resource'] = use_existed
+        connect = self._create_fake_connection()
+        with mock.patch(
+            "cloudify_libvirt.network_tasks.libvirt.open",
+            mock.Mock(return_value=connect)
+        ):
+            func(ctx=_ctx)
+
     def _test_empty_network_backup(self, func):
         # check correct handle exception with empty network
         _ctx = self._create_ctx()
@@ -407,6 +453,7 @@ def test_delete(self):
         self._test_no_resource_id(network_tasks.delete)
         self._test_empty_connection(network_tasks.delete)
         self._test_empty_network(network_tasks.delete)
+        self._test_reused_network(network_tasks.delete)
 
         # delete with error
         _ctx = self._create_ctx()
@@ -494,6 +541,9 @@ def test_create(self):
         self.assertEqual(
             _ctx.instance.runtime_properties['resource_id'], "network_name"
         )
+        self.assertFalse(
+            _ctx.instance.runtime_properties['use_external_resource']
+        )
 
         # unactive
         network.isActive = mock.Mock(return_value=0)

examples/cluster.yaml

@@ -7,7 +7,7 @@ imports:
   - http://www.getcloudify.org/spec/cloudify/4.3.1/types.yaml
   - http://www.getcloudify.org/spec/fabric-plugin/1.5.1/plugin.yaml
   - https://raw.githubusercontent.com/cloudify-incubator/cloudify-utilities-plugin/1.7.1/plugin.yaml
-  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4/plugin.yaml
+  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4.1/plugin.yaml
 
 inputs:
 

examples/vm_agent.yaml

@@ -3,7 +3,7 @@ tosca_definitions_version: cloudify_dsl_1_3
 imports:
   - http://www.getcloudify.org/spec/cloudify/4.3.1/types.yaml
   - https://raw.githubusercontent.com/cloudify-incubator/cloudify-utilities-plugin/1.7.1/plugin.yaml
-  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4/plugin.yaml
+  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4.1/plugin.yaml
 
 inputs:
 

examples/vm_centos.amd64.yaml

@@ -3,7 +3,7 @@ tosca_definitions_version: cloudify_dsl_1_3
 imports:
   - http://www.getcloudify.org/spec/cloudify/4.3.1/types.yaml
   - https://raw.githubusercontent.com/cloudify-incubator/cloudify-utilities-plugin/1.7.1/plugin.yaml
-  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4/plugin.yaml
+  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4.1/plugin.yaml
 
 inputs:
 

examples/vm_fabric.arm64.yaml

@@ -3,7 +3,7 @@ tosca_definitions_version: cloudify_dsl_1_3
 imports:
   - http://www.getcloudify.org/spec/cloudify/4.3.1/types.yaml
   - https://raw.githubusercontent.com/cloudify-incubator/cloudify-utilities-plugin/1.7.1/plugin.yaml
-  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4/plugin.yaml
+  - https://raw.githubusercontent.com/cloudify-incubator/cloudify-libvirt-plugin/0.4.1/plugin.yaml
 
 inputs:
 

plugin.yaml

@@ -2,8 +2,8 @@ plugins:
   libvirt:
     executor: central_deployment_agent
     package_name: cloudify-libvirt-plugin
-    package_version: '0.4.1'
-    source: https://github.com/cloudify-incubator/cloudify-libvirt-plugin/archive/0.4.1.zip
+    package_version: '0.5.0'
+    source: https://github.com/cloudify-incubator/cloudify-libvirt-plugin/archive/0.5.0.zip
 
 node_types: