gns3-server/gns3server/modules/base_vm.py

150 lines
3.7 KiB
Python
Raw Normal View History

2015-01-14 01:26:32 +00:00
# -*- coding: utf-8 -*-
#
# Copyright (C) 2015 GNS3 Technologies Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
2015-01-14 17:52:02 +00:00
import logging
import aiohttp
import shutil
import asyncio
from ..utils.asyncio import wait_run_in_executor
2015-01-14 17:52:02 +00:00
log = logging.getLogger(__name__)
2015-01-14 01:26:32 +00:00
2015-01-15 23:50:36 +00:00
2015-01-14 01:26:32 +00:00
class BaseVM:
def __init__(self, name, vm_id, project, manager):
2015-01-16 00:43:06 +00:00
2015-01-14 01:26:32 +00:00
self._name = name
self._id = vm_id
2015-01-20 11:46:15 +00:00
self._project = project
2015-01-19 10:22:24 +00:00
self._manager = manager
2015-01-14 17:52:02 +00:00
log.debug("{module}: {name} [{id}] initialized".format(module=self.manager.module_name,
name=self.name,
id=self.id))
2015-01-21 22:21:15 +00:00
2015-01-22 10:49:22 +00:00
def __del__(self):
self.close()
2015-01-19 10:22:24 +00:00
2015-01-20 11:46:15 +00:00
@property
def project(self):
"""
Returns the VM current project.
:returns: Project instance.
"""
2015-01-20 11:46:15 +00:00
return self._project
2015-01-14 01:26:32 +00:00
@property
def name(self):
2015-01-14 01:26:32 +00:00
"""
Returns the name for this VM.
2015-01-14 01:26:32 +00:00
:returns: name
2015-01-14 01:26:32 +00:00
"""
return self._name
@name.setter
def name(self, new_name):
"""
Sets the name of this VM.
:param new_name: name
"""
log.info("{module}: {name} [{id}] renamed to {new_name}".format(module=self.manager.module_name,
name=self.name,
id=self.id,
new_name=new_name))
self._name = new_name
2015-01-14 01:26:32 +00:00
@property
def id(self):
2015-01-14 01:26:32 +00:00
"""
Returns the ID for this VM.
2015-01-14 01:26:32 +00:00
:returns: VM identifier (string)
2015-01-14 01:26:32 +00:00
"""
return self._id
2015-01-14 01:26:32 +00:00
@property
def manager(self):
"""
Returns the manager for this VM.
:returns: instance of manager
"""
return self._manager
2015-01-14 01:26:32 +00:00
@property
def working_dir(self):
"""
Return VM working directory
"""
2015-01-23 10:28:58 +00:00
return self._project.vm_working_directory(self)
def create(self):
"""
Creates the VM.
"""
2015-01-14 01:26:32 +00:00
log.info("{module}: {name} [{id}] created".format(module=self.manager.module_name,
name=self.name,
id=self.id))
2015-01-14 01:26:32 +00:00
@asyncio.coroutine
def delete(self):
"""
Delete the VM (including all its files).
"""
2015-02-16 09:11:46 +00:00
directory = self.project.vm_working_directory(self)
if os.path.exists(directory):
try:
yield from wait_run_in_executor(shutil.rmtree, directory)
except OSError as e:
raise aiohttp.web.HTTPInternalServerError(text="Could not delete the VM working directory: {}".format(e))
2015-01-15 23:50:36 +00:00
def start(self):
2015-01-14 17:52:02 +00:00
"""
Starts the VM process.
"""
2015-01-14 17:52:02 +00:00
raise NotImplementedError
def stop(self):
"""
Starts the VM process.
2015-01-14 01:26:32 +00:00
"""
raise NotImplementedError
2015-01-22 10:49:22 +00:00
def close(self):
2015-01-22 10:49:22 +00:00
"""
Close the VM process.
2015-01-22 10:49:22 +00:00
"""
raise NotImplementedError