Refactoring to use a common node class for all VMs and other (future) objects.

gns3server/compute/dynamips/__init__.py

@@ -102,7 +102,7 @@ WIC_MATRIX = {"WIC-1ENET": WIC_1ENET,
 
 class Dynamips(BaseManager):
 
-    _VM_CLASS = DynamipsVM
+    _NODE_CLASS = DynamipsVM
     _DEVICE_CLASS = DynamipsDevice
     _ghost_ios_lock = None
 
@@ -142,7 +142,7 @@ class Dynamips(BaseManager):
 
     def release_dynamips_id(self, project_id, dynamips_id):
         """
-        A dynamips id can be reused by another vm
+        A Dynamips id can be reused by another VM
 
         :param project_id: UUID of the project
         :param dynamips_id: Asked id
@@ -231,9 +231,9 @@ class Dynamips(BaseManager):
         :param project: Project instance
         """
 
-        for vm in self._vms.values():
-            if vm.project.id == project.id:
-                yield from vm.hypervisor.set_working_dir(project.module_working_directory(self.module_name.lower()))
+        for node in self._nodes.values():
+            if node.project.id == project.id:
+                yield from node.hypervisor.set_working_dir(project.module_working_directory(self.module_name.lower()))
 
         for device in self._devices.values():
             if device.project.id == project.id:
@@ -248,10 +248,10 @@ class Dynamips(BaseManager):
         """
 
         # save the configs when the project is committed
-        for vm in self._vms.copy().values():
-            if vm.project.id == project.id:
+        for node in self._nodes.copy().values():
+            if node.project.id == project.id:
                 try:
-                    yield from vm.save_configs()
+                    yield from node.save_configs()
                 except DynamipsError as e:
                     log.warning(e)
                     continue
@@ -273,7 +273,6 @@ class Dynamips(BaseManager):
 
         :param name: Device name
         :param project_id: Project identifier
-        :param vm_id: restore a VM identifier
         """
 
         project = ProjectManager.instance().get_project(project_id)

gns3server/compute/dynamips/dynamips_error.py

@@ -19,9 +19,9 @@
 Custom exceptions for the Dynamips module.
 """
 
-from ..vm_error import VMError
+from ..node_error import NodeError
 
 
-class DynamipsError(VMError):
+class DynamipsError(NodeError):
 
     pass

gns3server/compute/dynamips/dynamips_vm.py

@@ -43,9 +43,9 @@ class DynamipsVM:
     Factory to create an Router object based on the correct platform.
     """
 
-    def __new__(cls, name, vm_id, project, manager, dynamips_id, platform, **kwargs):
+    def __new__(cls, name, node_id, project, manager, dynamips_id, platform, **kwargs):
 
         if platform not in PLATFORMS:
             raise DynamipsError("Unknown router platform: {}".format(platform))
 
-        return PLATFORMS[platform](name, vm_id, project, manager, dynamips_id, **kwargs)
+        return PLATFORMS[platform](name, node_id, project, manager, dynamips_id, **kwargs)

gns3server/compute/dynamips/nodes/c1700.py

@@ -35,7 +35,7 @@ class C1700(Router):
     Dynamips c1700 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node instance identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -46,9 +46,9 @@ class C1700(Router):
     1710 is not supported.
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis="1720"):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis="1720"):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c1700")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c1700")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 64

gns3server/compute/dynamips/nodes/c2600.py

@@ -37,7 +37,7 @@ class C2600(Router):
     Dynamips c2600 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -61,9 +61,9 @@ class C2600(Router):
                            "2650XM": C2600_MB_1FE,
                            "2651XM": C2600_MB_2FE}
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis="2610"):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis="2610"):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c2600")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c2600")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 64

gns3server/compute/dynamips/nodes/c2691.py

@@ -35,7 +35,7 @@ class C2691(Router):
     Dynamips c2691 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -43,9 +43,9 @@ class C2691(Router):
     :param aux: auxiliary console port
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c2691")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c2691")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 128

gns3server/compute/dynamips/nodes/c3600.py

@@ -34,7 +34,7 @@ class C3600(Router):
     Dynamips c3600 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -44,9 +44,9 @@ class C3600(Router):
     3620, 3640 or 3660 (default = 3640).
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis="3640"):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis="3640"):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c3600")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c3600")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 128

gns3server/compute/dynamips/nodes/c3725.py

@@ -35,7 +35,7 @@ class C3725(Router):
     Dynamips c3725 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -43,9 +43,9 @@ class C3725(Router):
     :param aux: auxiliary console port
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c3725")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c3725")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 128

gns3server/compute/dynamips/nodes/c3745.py

@@ -35,7 +35,7 @@ class C3745(Router):
     Dynamips c3745 router.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -43,9 +43,9 @@ class C3745(Router):
     :param aux: auxiliary console port
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, chassis=None):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c3745")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c3745")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 128

gns3server/compute/dynamips/nodes/c7200.py

@@ -37,7 +37,7 @@ class C7200(Router):
     Dynamips c7200 router (model is 7206).
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -46,9 +46,9 @@ class C7200(Router):
     :param npe: Default NPE
     """
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id, console=None, aux=None, npe="npe-400", chassis=None):
+    def __init__(self, name, node_id, project, manager, dynamips_id, console=None, aux=None, npe="npe-400", chassis=None):
 
-        super().__init__(name, vm_id, project, manager, dynamips_id, console, aux, platform="c7200")
+        super().__init__(name, node_id, project, manager, dynamips_id, console, aux, platform="c7200")
 
         # Set default values for this platform (must be the same as Dynamips)
         self._ram = 256

gns3server/compute/dynamips/nodes/device.py

@@ -69,7 +69,7 @@ class Device:
     @name.setter
     def name(self, new_name):
         """
-        Sets the name of this VM.
+        Sets the name of this device.
 
         :param new_name: name
         """

gns3server/compute/dynamips/nodes/router.py

@@ -31,7 +31,7 @@ import binascii
 import logging
 log = logging.getLogger(__name__)
 
-from ...base_vm import BaseVM
+from ...base_node import BaseNode
 from ..dynamips_error import DynamipsError
 from ..nios.nio_udp import NIOUDP
 
@@ -39,13 +39,13 @@ from gns3server.utils.asyncio import wait_run_in_executor, monitor_process
 from gns3server.utils.images import md5sum
 
 
-class Router(BaseVM):
+class Router(BaseNode):
 
     """
     Dynamips router implementation.
 
     :param name: The name of this router
-    :param vm_id: Router instance identifier
+    :param node_id: Node identifier
     :param project: Project instance
     :param manager: Parent VM Manager
     :param dynamips_id: ID to use with Dynamips
@@ -59,11 +59,11 @@ class Router(BaseVM):
                2: "running",
                3: "suspended"}
 
-    def __init__(self, name, vm_id, project, manager, dynamips_id=None, console=None, aux=None, platform="c7200", hypervisor=None, ghost_flag=False):
+    def __init__(self, name, node_id, project, manager, dynamips_id=None, console=None, aux=None, platform="c7200", hypervisor=None, ghost_flag=False):
 
         allocate_aux = manager.config.get_section_config("Dynamips").getboolean("allocate_aux_console_ports", False)
 
-        super().__init__(name, vm_id, project, manager, console=console, aux=aux, allocate_aux=aux)
+        super().__init__(name, node_id, project, manager, console=console, aux=aux, allocate_aux=aux)
 
         self._hypervisor = hypervisor
         self._dynamips_id = dynamips_id
@@ -111,7 +111,7 @@ class Router(BaseVM):
     def __json__(self):
 
         router_info = {"name": self.name,
-                       "vm_id": self.id,
+                       "node_id": self.id,
                        "vm_directory": os.path.join(self.project.module_working_directory(self.manager.module_name.lower())),
                        "project_id": self.project.id,
                        "dynamips_id": self._dynamips_id,
@@ -1549,7 +1549,7 @@ class Router(BaseVM):
 
     def delete(self):
         """
-        Delete the VM (including all its files).
+        Delete this VM (including all its files).
         """
 
         # delete the VM files