gns3-server/gns3server/modules/vmware/__init__.py

184 lines
7.1 KiB
Python
Raw Normal View History

# -*- 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/>.
"""
VMware player/workstation server module.
"""
import os
import sys
import shutil
import asyncio
import subprocess
import logging
log = logging.getLogger(__name__)
from ..base_manager import BaseManager
from .vmware_vm import VMwareVM
from .vmware_error import VMwareError
class VMware(BaseManager):
_VM_CLASS = VMwareVM
def __init__(self):
super().__init__()
self._vmrun_path = None
@property
def vmrun_path(self):
"""
Returns the path vmrun utility.
:returns: path
"""
return self._vmrun_path
def find_vmrun(self):
# look for vmrun
vmrun_path = self.config.get_section_config("VMware").get("vmrun_path")
if not vmrun_path:
if sys.platform.startswith("win"):
pass # TODO: use registry to find vmrun
elif sys.platform.startswith("darwin"):
vmrun_path = "/Applications/VMware Fusion.app/Contents/Library/vmrun"
else:
vmrun_path = shutil.which("vmrun")
if not vmrun_path:
raise VMwareError("Could not find vmrun")
if not os.path.isfile(vmrun_path):
raise VMwareError("vmrun {} is not accessible".format(vmrun_path))
if not os.access(vmrun_path, os.X_OK):
raise VMwareError("vmrun is not executable")
if os.path.basename(vmrun_path) not in ["vmrun", "vmrun.exe"]:
raise VMwareError("Invalid vmrun executable name {}".format(os.path.basename(vmrun_path)))
self._vmrun_path = vmrun_path
return vmrun_path
@asyncio.coroutine
def execute(self, subcommand, args, timeout=60, host_type=None):
vmrun_path = self.vmrun_path
if not vmrun_path:
vmrun_path = self.find_vmrun()
if host_type is None:
2015-05-02 00:47:46 +00:00
if sys.platform.startswith("darwin"):
host_type = "fusion"
else:
host_type = self.config.get_section_config("VMware").get("host_type", "ws")
command = [vmrun_path, "-T", host_type, subcommand]
command.extend(args)
log.debug("Executing vmrun with command: {}".format(command))
try:
process = yield from asyncio.create_subprocess_exec(*command, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
except (OSError, subprocess.SubprocessError) as e:
raise VMwareError("Could not execute vmrun: {}".format(e))
try:
stdout_data, _ = yield from asyncio.wait_for(process.communicate(), timeout=timeout)
except asyncio.TimeoutError:
raise VMwareError("vmrun has timed out after {} seconds!".format(timeout))
if process.returncode:
# vmrun print errors on stdout
vmrun_error = stdout_data.decode("utf-8", errors="ignore")
raise VMwareError("vmrun has returned an error: {}".format(vmrun_error))
return stdout_data.decode("utf-8", errors="ignore").splitlines()
2015-05-02 00:47:46 +00:00
def _get_vms_from_inventory(self, inventory_path):
2015-05-02 00:47:46 +00:00
vm_entries = {}
2015-05-02 00:47:46 +00:00
vms = []
try:
with open(inventory_path, encoding="utf-8") as f:
for line in f.read().splitlines():
try:
name, value = line.split('=', 1)
vm_entry, variable_name = name.split('.', 1)
if vm_entry.startswith("vmlist"):
if not vm_entry in vm_entries:
vm_entries[vm_entry] = {}
vm_entries[vm_entry][variable_name.strip()] = value.strip('" ')
except ValueError:
continue
except OSError as e:
log.warning("Could not read VMware inventory file {}: {}".format(inventory_path, e))
for vm_settings in vm_entries.values():
if "DisplayName" in vm_settings and "config" in vm_settings:
vms.append({"vmname": vm_settings["DisplayName"], "vmx_path": vm_settings["config"]})
return vms
def _get_vms_from_default_folder(self, folder):
vms = []
for path, _, filenames in os.walk(folder):
2015-05-02 00:47:46 +00:00
for filename in filenames:
if os.path.splitext(filename)[1] == ".vmx":
vmx_path = os.path.join(path, filename)
try:
with open(vmx_path, encoding="utf-8") as f:
for line in f.read().splitlines():
try:
name, value = line.split('=', 1)
if name.strip() == "displayName":
vmname = value.strip('" ')
vms.append({"vmname": vmname, "vmx_path": vmx_path})
break
except ValueError:
continue
except OSError as e:
2015-05-02 00:47:46 +00:00
log.warning("Could not read VMware vmx file {}: {}".format(vmx_path, e))
continue
return vms
def list_vms(self):
"""
Gets VMware VM list.
"""
if sys.platform.startswith("win"):
inventory_path = os.path.expandvars(r"%APPDATA%\Vmware\Inventory.vmls")
elif sys.platform.startswith("darwin"):
inventory_path = os.path.expanduser("~/Library/Application\ Support/VMware Fusion/vmInventory")
else:
inventory_path = os.path.expanduser("~/.vmware/inventory.vmls")
if os.path.exists(inventory_path):
return self._get_vms_from_inventory(inventory_path)
else:
# VMware player has no inventory file, let's use the default location for VMs.
# TODO: default location can be changed in the preferences file (prefvmx.defaultvmpath = "path")
# Windows: %APPDATA%\Vmware\preferences.ini
# Linux: ~/.vmware/preferences
if sys.platform.startswith("win"):
default_vm_path = os.path.expandvars(r"%USERPROFILE%\Documents\Virtual Machines")
else:
default_vm_path = os.path.expanduser("~/vmware") # FIXME: check if correct path on OSX
if os.path.isdir(default_vm_path):
return self._get_vms_from_default_folder(default_vm_path)
log.warning("Default VMware VM location doesn't exist: {}".format(default_vm_path))