ovf.py 66 KB
Newer Older
1 2 3
#!/usr/bin/python
#

4
# Copyright (C) 2011, 2012 Google Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Converter tools between ovf and ganeti config file

"""

Agata Murawska's avatar
Agata Murawska committed
26 27 28 29 30 31
# pylint: disable=F0401, E1101

# F0401 because ElementTree is not default for python 2.4
# E1101 makes no sense - pylint assumes that ElementTree object is a tuple


32
import ConfigParser
Agata Murawska's avatar
Agata Murawska committed
33
import errno
Agata Murawska's avatar
Agata Murawska committed
34
import logging
Agata Murawska's avatar
Agata Murawska committed
35
import os
36
import os.path
Agata Murawska's avatar
Agata Murawska committed
37
import re
38
import shutil
Agata Murawska's avatar
Agata Murawska committed
39 40
import tarfile
import tempfile
41
import xml.dom.minidom
Agata Murawska's avatar
Agata Murawska committed
42 43 44 45 46
import xml.parsers.expat
try:
  import xml.etree.ElementTree as ET
except ImportError:
  import elementtree.ElementTree as ET
47

48 49 50 51 52
try:
  ParseError = ET.ParseError # pylint: disable=E1103
except AttributeError:
  ParseError = None

Agata Murawska's avatar
Agata Murawska committed
53
from ganeti import constants
54 55
from ganeti import errors
from ganeti import utils
56
from ganeti import pathutils
57 58


Agata Murawska's avatar
Agata Murawska committed
59 60 61 62 63
# Schemas used in OVF format
GANETI_SCHEMA = "http://ganeti"
OVF_SCHEMA = "http://schemas.dmtf.org/ovf/envelope/1"
RASD_SCHEMA = ("http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/"
               "CIM_ResourceAllocationSettingData")
64 65 66
VSSD_SCHEMA = ("http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/"
               "CIM_VirtualSystemSettingData")
XML_SCHEMA = "http://www.w3.org/2001/XMLSchema-instance"
Agata Murawska's avatar
Agata Murawska committed
67 68 69 70 71 72

# File extensions in OVF package
OVA_EXT = ".ova"
OVF_EXT = ".ovf"
MF_EXT = ".mf"
CERT_EXT = ".cert"
Agata Murawska's avatar
Agata Murawska committed
73
COMPRESSION_EXT = ".gz"
Agata Murawska's avatar
Agata Murawska committed
74 75 76 77 78 79
FILE_EXTENSIONS = [
  OVF_EXT,
  MF_EXT,
  CERT_EXT,
]

Agata Murawska's avatar
Agata Murawska committed
80
COMPRESSION_TYPE = "gzip"
81
NO_COMPRESSION = [None, "identity"]
Agata Murawska's avatar
Agata Murawska committed
82 83 84 85
COMPRESS = "compression"
DECOMPRESS = "decompression"
ALLOWED_ACTIONS = [COMPRESS, DECOMPRESS]

86 87 88 89 90
VMDK = "vmdk"
RAW = "raw"
COW = "cow"
ALLOWED_FORMATS = [RAW, COW, VMDK]

91 92 93 94
# ResourceType values
RASD_TYPE = {
  "vcpus": "3",
  "memory": "4",
95 96 97
  "scsi-controller": "6",
  "ethernet-adapter": "10",
  "disk": "17",
98 99
}

100 101 102 103 104 105
SCSI_SUBTYPE = "lsilogic"
VS_TYPE = {
  "ganeti": "ganeti-ovf",
  "external": "vmx-04",
}

106 107
# AllocationUnits values and conversion
ALLOCATION_UNITS = {
108 109 110 111
  "b": ["bytes", "b"],
  "kb": ["kilobytes", "kb", "byte * 2^10", "kibibytes", "kib"],
  "mb": ["megabytes", "mb", "byte * 2^20", "mebibytes", "mib"],
  "gb": ["gigabytes", "gb", "byte * 2^30", "gibibytes", "gib"],
112 113
}
CONVERT_UNITS_TO_MB = {
114 115 116 117
  "b": lambda x: x / (1024 * 1024),
  "kb": lambda x: x / 1024,
  "mb": lambda x: x,
  "gb": lambda x: x * 1024,
118 119
}

120 121
# Names of the config fields
NAME = "name"
122 123 124 125 126 127 128 129
OS = "os"
HYPERV = "hypervisor"
VCPUS = "vcpus"
MEMORY = "memory"
AUTO_BALANCE = "auto_balance"
DISK_TEMPLATE = "disk_template"
TAGS = "tags"
VERSION = "version"
130

131
# Instance IDs of System and SCSI controller
132 133 134 135 136 137
INSTANCE_ID = {
  "system": 0,
  "vcpus": 1,
  "memory": 2,
  "scsi": 3,
}
138 139 140

# Disk format descriptions
DISK_FORMAT = {
141 142
  RAW: "http://en.wikipedia.org/wiki/Byte",
  VMDK: "http://www.vmware.com/interfaces/specifications/vmdk.html"
143
          "#monolithicSparse",
144
  COW: "http://www.gnome.org/~markmc/qcow-image-format.html",
145 146
}

147

148 149 150 151 152 153 154 155
def CheckQemuImg():
  """ Make sure that qemu-img is present before performing operations.

  @raise errors.OpPrereqError: when qemu-img was not found in the system

  """
  if not constants.QEMUIMG_PATH:
    raise errors.OpPrereqError("qemu-img not found at build time, unable"
156
                               " to continue", errors.ECODE_STATE)
Agata Murawska's avatar
Agata Murawska committed
157

158

Agata Murawska's avatar
Agata Murawska committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
def LinkFile(old_path, prefix=None, suffix=None, directory=None):
  """Create link with a given prefix and suffix.

  This is a wrapper over os.link. It tries to create a hard link for given file,
  but instead of rising error when file exists, the function changes the name
  a little bit.

  @type old_path:string
  @param old_path: path to the file that is to be linked
  @type prefix: string
  @param prefix: prefix of filename for the link
  @type suffix: string
  @param suffix: suffix of the filename for the link
  @type directory: string
  @param directory: directory of the link

  @raise errors.OpPrereqError: when error on linking is different than
    "File exists"

  """
  assert(prefix is not None or suffix is not None)
  if directory is None:
    directory = os.getcwd()
  new_path = utils.PathJoin(directory, "%s%s" % (prefix, suffix))
  counter = 1
  while True:
    try:
      os.link(old_path, new_path)
      break
    except OSError, err:
      if err.errno == errno.EEXIST:
        new_path = utils.PathJoin(directory,
Iustin Pop's avatar
Iustin Pop committed
191
                                  "%s_%s%s" % (prefix, counter, suffix))
Agata Murawska's avatar
Agata Murawska committed
192 193 194
        counter += 1
      else:
        raise errors.OpPrereqError("Error moving the file %s to %s location:"
195 196
                                   " %s" % (old_path, new_path, err),
                                   errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
197 198
  return new_path

Agata Murawska's avatar
Agata Murawska committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

class OVFReader(object):
  """Reader class for OVF files.

  @type files_list: list
  @ivar files_list: list of files in the OVF package
  @type tree: ET.ElementTree
  @ivar tree: XML tree of the .ovf file
  @type schema_name: string
  @ivar schema_name: name of the .ovf file
  @type input_dir: string
  @ivar input_dir: directory in which the .ovf file resides

  """
  def __init__(self, input_path):
    """Initialiaze the reader - load the .ovf file to XML parser.

    It is assumed that names of manifesto (.mf), certificate (.cert) and ovf
    files are the same. In order to account any other files as part of the ovf
    package, they have to be explicitly mentioned in the Resources section
    of the .ovf file.

    @type input_path: string
    @param input_path: absolute path to the .ovf file

    @raise errors.OpPrereqError: when .ovf file is not a proper XML file or some
      of the files mentioned in Resources section do not exist

    """
    self.tree = ET.ElementTree()
    try:
      self.tree.parse(input_path)
231
    except (ParseError, xml.parsers.expat.ExpatError), err:
Agata Murawska's avatar
Agata Murawska committed
232
      raise errors.OpPrereqError("Error while reading %s file: %s" %
233
                                 (OVF_EXT, err), errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

    # Create a list of all files in the OVF package
    (input_dir, input_file) = os.path.split(input_path)
    (input_name, _) = os.path.splitext(input_file)
    files_directory = utils.ListVisibleFiles(input_dir)
    files_list = []
    for file_name in files_directory:
      (name, extension) = os.path.splitext(file_name)
      if extension in FILE_EXTENSIONS and name == input_name:
        files_list.append(file_name)
    files_list += self._GetAttributes("{%s}References/{%s}File" %
                                      (OVF_SCHEMA, OVF_SCHEMA),
                                      "{%s}href" % OVF_SCHEMA)
    for file_name in files_list:
      file_path = utils.PathJoin(input_dir, file_name)
      if not os.path.exists(file_path):
250 251
        raise errors.OpPrereqError("File does not exist: %s" % file_path,
                                   errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    logging.info("Files in the OVF package: %s", " ".join(files_list))
    self.files_list = files_list
    self.input_dir = input_dir
    self.schema_name = input_name

  def _GetAttributes(self, path, attribute):
    """Get specified attribute from all nodes accessible using given path.

    Function follows the path from root node to the desired tags using path,
    then reads the apropriate attribute values.

    @type path: string
    @param path: path of nodes to visit
    @type attribute: string
    @param attribute: attribute for which we gather the information
    @rtype: list
    @return: for each accessible tag with the attribute value set, value of the
      attribute

    """
    current_list = self.tree.findall(path)
    results = [x.get(attribute) for x in current_list]
    return filter(None, results)

Agata Murawska's avatar
Agata Murawska committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
  def _GetElementMatchingAttr(self, path, match_attr):
    """Searches for element on a path that matches certain attribute value.

    Function follows the path from root node to the desired tags using path,
    then searches for the first one matching the attribute value.

    @type path: string
    @param path: path of nodes to visit
    @type match_attr: tuple
    @param match_attr: pair (attribute, value) for which we search
    @rtype: ET.ElementTree or None
    @return: first element matching match_attr or None if nothing matches

    """
    potential_elements = self.tree.findall(path)
    (attr, val) = match_attr
    for elem in potential_elements:
      if elem.get(attr) == val:
        return elem
    return None

Agata Murawska's avatar
Agata Murawska committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
  def _GetElementMatchingText(self, path, match_text):
    """Searches for element on a path that matches certain text value.

    Function follows the path from root node to the desired tags using path,
    then searches for the first one matching the text value.

    @type path: string
    @param path: path of nodes to visit
    @type match_text: tuple
    @param match_text: pair (node, text) for which we search
    @rtype: ET.ElementTree or None
    @return: first element matching match_text or None if nothing matches

    """
    potential_elements = self.tree.findall(path)
    (node, text) = match_text
    for elem in potential_elements:
      if elem.findtext(node) == text:
        return elem
    return None

Agata Murawska's avatar
Agata Murawska committed
318 319 320 321 322 323 324 325 326 327 328 329 330
  @staticmethod
  def _GetDictParameters(root, schema):
    """Reads text in all children and creates the dictionary from the contents.

    @type root: ET.ElementTree or None
    @param root: father of the nodes we want to collect data about
    @type schema: string
    @param schema: schema name to be removed from the tag
    @rtype: dict
    @return: dictionary containing tags and their text contents, tags have their
      schema fragment removed or empty dictionary, when root is None

    """
331
    if root is None:
Agata Murawska's avatar
Agata Murawska committed
332 333 334 335 336 337 338 339 340
      return {}
    results = {}
    for element in list(root):
      pref_len = len("{%s}" % schema)
      assert(schema in element.tag)
      tag = element.tag[pref_len:]
      results[tag] = element.text
    return results

Agata Murawska's avatar
Agata Murawska committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
  def VerifyManifest(self):
    """Verifies manifest for the OVF package, if one is given.

    @raise errors.OpPrereqError: if SHA1 checksums do not match

    """
    if "%s%s" % (self.schema_name, MF_EXT) in self.files_list:
      logging.warning("Verifying SHA1 checksums, this may take a while")
      manifest_filename = "%s%s" % (self.schema_name, MF_EXT)
      manifest_path = utils.PathJoin(self.input_dir, manifest_filename)
      manifest_content = utils.ReadFile(manifest_path).splitlines()
      manifest_files = {}
      regexp = r"SHA1\((\S+)\)= (\S+)"
      for line in manifest_content:
        match = re.match(regexp, line)
        if match:
          file_name = match.group(1)
          sha1_sum = match.group(2)
          manifest_files[file_name] = sha1_sum
      files_with_paths = [utils.PathJoin(self.input_dir, file_name)
Iustin Pop's avatar
Iustin Pop committed
361
                          for file_name in self.files_list]
Agata Murawska's avatar
Agata Murawska committed
362 363 364 365
      sha1_sums = utils.FingerprintFiles(files_with_paths)
      for file_name, value in manifest_files.iteritems():
        if sha1_sums.get(utils.PathJoin(self.input_dir, file_name)) != value:
          raise errors.OpPrereqError("SHA1 checksum of %s does not match the"
366 367
                                     " value in manifest file" % file_name,
                                     errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
368 369
      logging.info("SHA1 checksums verified")

Agata Murawska's avatar
Agata Murawska committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
  def GetInstanceName(self):
    """Provides information about instance name.

    @rtype: string
    @return: instance name string

    """
    find_name = "{%s}VirtualSystem/{%s}Name" % (OVF_SCHEMA, OVF_SCHEMA)
    return self.tree.findtext(find_name)

  def GetDiskTemplate(self):
    """Returns disk template from .ovf file

    @rtype: string or None
    @return: name of the template
    """
    find_template = ("{%s}GanetiSection/{%s}DiskTemplate" %
                     (GANETI_SCHEMA, GANETI_SCHEMA))
    return self.tree.findtext(find_template)

390 391 392 393 394 395 396 397 398 399 400
  def GetHypervisorData(self):
    """Provides hypervisor information - hypervisor name and options.

    @rtype: dict
    @return: dictionary containing name of the used hypervisor and all the
      specified options

    """
    hypervisor_search = ("{%s}GanetiSection/{%s}Hypervisor" %
                         (GANETI_SCHEMA, GANETI_SCHEMA))
    hypervisor_data = self.tree.find(hypervisor_search)
401
    if hypervisor_data is None:
402 403 404
      return {"hypervisor_name": constants.VALUE_AUTO}
    results = {
      "hypervisor_name": hypervisor_data.findtext("{%s}Name" % GANETI_SCHEMA,
Iustin Pop's avatar
Iustin Pop committed
405
                                                  default=constants.VALUE_AUTO),
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
    }
    parameters = hypervisor_data.find("{%s}Parameters" % GANETI_SCHEMA)
    results.update(self._GetDictParameters(parameters, GANETI_SCHEMA))
    return results

  def GetOSData(self):
    """ Provides operating system information - os name and options.

    @rtype: dict
    @return: dictionary containing name and options for the chosen OS

    """
    results = {}
    os_search = ("{%s}GanetiSection/{%s}OperatingSystem" %
                 (GANETI_SCHEMA, GANETI_SCHEMA))
    os_data = self.tree.find(os_search)
422
    if os_data is not None:
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
      results["os_name"] = os_data.findtext("{%s}Name" % GANETI_SCHEMA)
      parameters = os_data.find("{%s}Parameters" % GANETI_SCHEMA)
      results.update(self._GetDictParameters(parameters, GANETI_SCHEMA))
    return results

  def GetBackendData(self):
    """ Provides backend information - vcpus, memory, auto balancing options.

    @rtype: dict
    @return: dictionary containing options for vcpus, memory and auto balance
      settings

    """
    results = {}

    find_vcpus = ("{%s}VirtualSystem/{%s}VirtualHardwareSection/{%s}Item" %
                   (OVF_SCHEMA, OVF_SCHEMA, OVF_SCHEMA))
    match_vcpus = ("{%s}ResourceType" % RASD_SCHEMA, RASD_TYPE["vcpus"])
    vcpus = self._GetElementMatchingText(find_vcpus, match_vcpus)
442
    if vcpus is not None:
443
      vcpus_count = vcpus.findtext("{%s}VirtualQuantity" % RASD_SCHEMA,
Iustin Pop's avatar
Iustin Pop committed
444
                                   default=constants.VALUE_AUTO)
445 446 447 448 449 450 451 452
    else:
      vcpus_count = constants.VALUE_AUTO
    results["vcpus"] = str(vcpus_count)

    find_memory = find_vcpus
    match_memory = ("{%s}ResourceType" % RASD_SCHEMA, RASD_TYPE["memory"])
    memory = self._GetElementMatchingText(find_memory, match_memory)
    memory_raw = None
453
    if memory is not None:
454
      alloc_units = memory.findtext("{%s}AllocationUnits" % RASD_SCHEMA)
Iustin Pop's avatar
Iustin Pop committed
455 456
      matching_units = [units for units, variants in ALLOCATION_UNITS.items()
                        if alloc_units.lower() in variants]
457
      if matching_units == []:
458 459
        raise errors.OpPrereqError("Unit %s for RAM memory unknown" %
                                   alloc_units, errors.ECODE_INVAL)
460 461
      units = matching_units[0]
      memory_raw = int(memory.findtext("{%s}VirtualQuantity" % RASD_SCHEMA,
Iustin Pop's avatar
Iustin Pop committed
462
                                       default=constants.VALUE_AUTO))
463 464 465 466 467 468
      memory_count = CONVERT_UNITS_TO_MB[units](memory_raw)
    else:
      memory_count = constants.VALUE_AUTO
    results["memory"] = str(memory_count)

    find_balance = ("{%s}GanetiSection/{%s}AutoBalance" %
Iustin Pop's avatar
Iustin Pop committed
469
                    (GANETI_SCHEMA, GANETI_SCHEMA))
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
    balance = self.tree.findtext(find_balance, default=constants.VALUE_AUTO)
    results["auto_balance"] = balance

    return results

  def GetTagsData(self):
    """Provides tags information for instance.

    @rtype: string or None
    @return: string of comma-separated tags for the instance

    """
    find_tags = "{%s}GanetiSection/{%s}Tags" % (GANETI_SCHEMA, GANETI_SCHEMA)
    results = self.tree.findtext(find_tags)
    if results:
      return results
    else:
      return None

  def GetVersionData(self):
    """Provides version number read from .ovf file

    @rtype: string
    @return: string containing the version number

    """
    find_version = ("{%s}GanetiSection/{%s}Version" %
                    (GANETI_SCHEMA, GANETI_SCHEMA))
    return self.tree.findtext(find_version)

Agata Murawska's avatar
Agata Murawska committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  def GetNetworkData(self):
    """Provides data about the network in the OVF instance.

    The method gathers the data about networks used by OVF instance. It assumes
    that 'name' tag means something - in essence, if it contains one of the
    words 'bridged' or 'routed' then that will be the mode of this network in
    Ganeti. The information about the network can be either in GanetiSection or
    VirtualHardwareSection.

    @rtype: dict
    @return: dictionary containing all the network information

    """
    results = {}
    networks_search = ("{%s}NetworkSection/{%s}Network" %
                       (OVF_SCHEMA, OVF_SCHEMA))
    network_names = self._GetAttributes(networks_search,
Iustin Pop's avatar
Iustin Pop committed
517
                                        "{%s}name" % OVF_SCHEMA)
518
    required = ["ip", "mac", "link", "mode", "network"]
Agata Murawska's avatar
Agata Murawska committed
519 520 521 522 523 524 525 526 527
    for (counter, network_name) in enumerate(network_names):
      network_search = ("{%s}VirtualSystem/{%s}VirtualHardwareSection/{%s}Item"
                        % (OVF_SCHEMA, OVF_SCHEMA, OVF_SCHEMA))
      ganeti_search = ("{%s}GanetiSection/{%s}Network/{%s}Nic" %
                       (GANETI_SCHEMA, GANETI_SCHEMA, GANETI_SCHEMA))
      network_match = ("{%s}Connection" % RASD_SCHEMA, network_name)
      ganeti_match = ("{%s}name" % OVF_SCHEMA, network_name)
      network_data = self._GetElementMatchingText(network_search, network_match)
      network_ganeti_data = self._GetElementMatchingAttr(ganeti_search,
Iustin Pop's avatar
Iustin Pop committed
528
                                                         ganeti_match)
Agata Murawska's avatar
Agata Murawska committed
529 530

      ganeti_data = {}
531
      if network_ganeti_data is not None:
Agata Murawska's avatar
Agata Murawska committed
532 533 534 535 536 537 538 539
        ganeti_data["mode"] = network_ganeti_data.findtext("{%s}Mode" %
                                                           GANETI_SCHEMA)
        ganeti_data["mac"] = network_ganeti_data.findtext("{%s}MACAddress" %
                                                          GANETI_SCHEMA)
        ganeti_data["ip"] = network_ganeti_data.findtext("{%s}IPAddress" %
                                                         GANETI_SCHEMA)
        ganeti_data["link"] = network_ganeti_data.findtext("{%s}Link" %
                                                           GANETI_SCHEMA)
Dimitris Aragiorgis's avatar
Dimitris Aragiorgis committed
540
        ganeti_data["network"] = network_ganeti_data.findtext("{%s}Net" %
541
                                                              GANETI_SCHEMA)
Agata Murawska's avatar
Agata Murawska committed
542
      mac_data = None
543
      if network_data is not None:
Agata Murawska's avatar
Agata Murawska committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
        mac_data = network_data.findtext("{%s}Address" % RASD_SCHEMA)

      network_name = network_name.lower()

      # First, some not Ganeti-specific information is collected
      if constants.NIC_MODE_BRIDGED in network_name:
        results["nic%s_mode" % counter] = "bridged"
      elif constants.NIC_MODE_ROUTED in network_name:
        results["nic%s_mode" % counter] = "routed"
      results["nic%s_mac" % counter] = mac_data

      # GanetiSection data overrides 'manually' collected data
      for name, value in ganeti_data.iteritems():
        results["nic%s_%s" % (counter, name)] = value

      # Bridged network has no IP - unless specifically stated otherwise
      if (results.get("nic%s_mode" % counter) == "bridged" and
          not results.get("nic%s_ip" % counter)):
        results["nic%s_ip" % counter] = constants.VALUE_NONE

      for option in required:
        if not results.get("nic%s_%s" % (counter, option)):
          results["nic%s_%s" % (counter, option)] = constants.VALUE_AUTO

    if network_names:
      results["nic_count"] = str(len(network_names))
    return results

Agata Murawska's avatar
Agata Murawska committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
  def GetDisksNames(self):
    """Provides list of file names for the disks used by the instance.

    @rtype: list
    @return: list of file names, as referenced in .ovf file

    """
    results = []
    disks_search = "{%s}DiskSection/{%s}Disk" % (OVF_SCHEMA, OVF_SCHEMA)
    disk_ids = self._GetAttributes(disks_search, "{%s}fileRef" % OVF_SCHEMA)
    for disk in disk_ids:
      disk_search = "{%s}References/{%s}File" % (OVF_SCHEMA, OVF_SCHEMA)
      disk_match = ("{%s}id" % OVF_SCHEMA, disk)
      disk_elem = self._GetElementMatchingAttr(disk_search, disk_match)
      if disk_elem is None:
        raise errors.OpPrereqError("%s file corrupted - disk %s not found in"
588 589
                                   " references" % (OVF_EXT, disk),
                                   errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
590 591 592 593 594
      disk_name = disk_elem.get("{%s}href" % OVF_SCHEMA)
      disk_compression = disk_elem.get("{%s}compression" % OVF_SCHEMA)
      results.append((disk_name, disk_compression))
    return results

Agata Murawska's avatar
Agata Murawska committed
595

596 597 598 599 600 601 602 603 604 605 606 607
def SubElementText(parent, tag, text, attrib={}, **extra):
# pylint: disable=W0102
  """This is just a wrapper on ET.SubElement that always has text content.

  """
  if text is None:
    return None
  elem = ET.SubElement(parent, tag, attrib=attrib, **extra)
  elem.text = str(text)
  return elem


608 609 610 611 612
class OVFWriter(object):
  """Writer class for OVF files.

  @type tree: ET.ElementTree
  @ivar tree: XML tree that we are constructing
613 614 615
  @type virtual_system_type: string
  @ivar virtual_system_type: value of vssd:VirtualSystemType, for external usage
    in VMWare this requires to be vmx
616 617
  @type hardware_list: list
  @ivar hardware_list: list of items prepared for VirtualHardwareSection
618 619 620
  @type next_instance_id: int
  @ivar next_instance_id: next instance id to be used when creating elements on
    hardware_list
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640

  """
  def __init__(self, has_gnt_section):
    """Initialize the writer - set the top element.

    @type has_gnt_section: bool
    @param has_gnt_section: if the Ganeti schema should be added - i.e. this
      means that Ganeti section will be present

    """
    env_attribs = {
      "xmlns:xsi": XML_SCHEMA,
      "xmlns:vssd": VSSD_SCHEMA,
      "xmlns:rasd": RASD_SCHEMA,
      "xmlns:ovf": OVF_SCHEMA,
      "xmlns": OVF_SCHEMA,
      "xml:lang": "en-US",
    }
    if has_gnt_section:
      env_attribs["xmlns:gnt"] = GANETI_SCHEMA
641 642 643
      self.virtual_system_type = VS_TYPE["ganeti"]
    else:
      self.virtual_system_type = VS_TYPE["external"]
644
    self.tree = ET.Element("Envelope", attrib=env_attribs)
645
    self.hardware_list = []
646 647
    # INSTANCE_ID contains statically assigned IDs, starting from 0
    self.next_instance_id = len(INSTANCE_ID) # FIXME: hackish
648 649 650 651 652 653 654 655 656 657

  def SaveDisksData(self, disks):
    """Convert disk information to certain OVF sections.

    @type disks: list
    @param disks: list of dictionaries of disk options from config.ini

    """
    references = ET.SubElement(self.tree, "References")
    disk_section = ET.SubElement(self.tree, "DiskSection")
658
    SubElementText(disk_section, "Info", "Virtual disk information")
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
    for counter, disk in enumerate(disks):
      file_id = "file%s" % counter
      disk_id = "disk%s" % counter
      file_attribs = {
        "ovf:href": disk["path"],
        "ovf:size": str(disk["real-size"]),
        "ovf:id": file_id,
      }
      disk_attribs = {
        "ovf:capacity": str(disk["virt-size"]),
        "ovf:diskId": disk_id,
        "ovf:fileRef": file_id,
        "ovf:format": DISK_FORMAT.get(disk["format"], disk["format"]),
      }
      if "compression" in disk:
        file_attribs["ovf:compression"] = disk["compression"]
      ET.SubElement(references, "File", attrib=file_attribs)
      ET.SubElement(disk_section, "Disk", attrib=disk_attribs)

      # Item in VirtualHardwareSection creation
      disk_item = ET.Element("Item")
      SubElementText(disk_item, "rasd:ElementName", disk_id)
      SubElementText(disk_item, "rasd:HostResource", "ovf:/disk/%s" % disk_id)
682 683 684
      SubElementText(disk_item, "rasd:InstanceID", self.next_instance_id)
      SubElementText(disk_item, "rasd:Parent", INSTANCE_ID["scsi"])
      SubElementText(disk_item, "rasd:ResourceType", RASD_TYPE["disk"])
685
      self.hardware_list.append(disk_item)
686
      self.next_instance_id += 1
687 688 689 690 691 692 693 694 695

  def SaveNetworksData(self, networks):
    """Convert network information to NetworkSection.

    @type networks: list
    @param networks: list of dictionaries of network options form config.ini

    """
    network_section = ET.SubElement(self.tree, "NetworkSection")
696
    SubElementText(network_section, "Info", "List of logical networks")
697 698 699 700 701 702 703
    for counter, network in enumerate(networks):
      network_name = "%s%s" % (network["mode"], counter)
      network_attrib = {"ovf:name": network_name}
      ET.SubElement(network_section, "Network", attrib=network_attrib)

      # Item in VirtualHardwareSection creation
      network_item = ET.Element("Item")
704 705
      SubElementText(network_item, "rasd:Address", network["mac"])
      SubElementText(network_item, "rasd:Connection", network_name)
706
      SubElementText(network_item, "rasd:ElementName", network_name)
707
      SubElementText(network_item, "rasd:InstanceID", self.next_instance_id)
708
      SubElementText(network_item, "rasd:ResourceType",
Iustin Pop's avatar
Iustin Pop committed
709
                     RASD_TYPE["ethernet-adapter"])
710
      self.hardware_list.append(network_item)
711
      self.next_instance_id += 1
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

  @staticmethod
  def _SaveNameAndParams(root, data):
    """Save name and parameters information under root using data.

    @type root: ET.Element
    @param root: root element for the Name and Parameters
    @type data: dict
    @param data: data from which we gather the values

    """
    assert(data.get("name"))
    name = SubElementText(root, "gnt:Name", data["name"])
    params = ET.SubElement(root, "gnt:Parameters")
    for name, value in data.iteritems():
      if name != "name":
        SubElementText(params, "gnt:%s" % name, value)

  def SaveGanetiData(self, ganeti, networks):
    """Convert Ganeti-specific information to GanetiSection.

    @type ganeti: dict
    @param ganeti: dictionary of Ganeti-specific options from config.ini
    @type networks: list
    @param networks: list of dictionaries of network options form config.ini

    """
    ganeti_section = ET.SubElement(self.tree, "gnt:GanetiSection")

    SubElementText(ganeti_section, "gnt:Version", ganeti.get("version"))
    SubElementText(ganeti_section, "gnt:DiskTemplate",
Iustin Pop's avatar
Iustin Pop committed
743
                   ganeti.get("disk_template"))
744
    SubElementText(ganeti_section, "gnt:AutoBalance",
Iustin Pop's avatar
Iustin Pop committed
745
                   ganeti.get("auto_balance"))
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
    SubElementText(ganeti_section, "gnt:Tags", ganeti.get("tags"))

    osys = ET.SubElement(ganeti_section, "gnt:OperatingSystem")
    self._SaveNameAndParams(osys, ganeti["os"])

    hypervisor = ET.SubElement(ganeti_section, "gnt:Hypervisor")
    self._SaveNameAndParams(hypervisor, ganeti["hypervisor"])

    network_section = ET.SubElement(ganeti_section, "gnt:Network")
    for counter, network in enumerate(networks):
      network_name = "%s%s" % (network["mode"], counter)
      nic_attrib = {"ovf:name": network_name}
      nic = ET.SubElement(network_section, "gnt:Nic", attrib=nic_attrib)
      SubElementText(nic, "gnt:Mode", network["mode"])
      SubElementText(nic, "gnt:MACAddress", network["mac"])
      SubElementText(nic, "gnt:IPAddress", network["ip"])
      SubElementText(nic, "gnt:Link", network["link"])
763
      SubElementText(nic, "gnt:Net", network["network"])
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

  def SaveVirtualSystemData(self, name, vcpus, memory):
    """Convert virtual system information to OVF sections.

    @type name: string
    @param name: name of the instance
    @type vcpus: int
    @param vcpus: number of VCPUs
    @type memory: int
    @param memory: RAM memory in MB

    """
    assert(vcpus > 0)
    assert(memory > 0)
    vs_attrib = {"ovf:id": name}
    virtual_system = ET.SubElement(self.tree, "VirtualSystem", attrib=vs_attrib)
780
    SubElementText(virtual_system, "Info", "A virtual machine")
781 782 783 784

    name_section = ET.SubElement(virtual_system, "Name")
    name_section.text = name
    os_attrib = {"ovf:id": "0"}
785
    os_section = ET.SubElement(virtual_system, "OperatingSystemSection",
Iustin Pop's avatar
Iustin Pop committed
786
                               attrib=os_attrib)
787
    SubElementText(os_section, "Info", "Installed guest operating system")
788
    hardware_section = ET.SubElement(virtual_system, "VirtualHardwareSection")
789
    SubElementText(hardware_section, "Info", "Virtual hardware requirements")
790 791 792 793

    # System description
    system = ET.SubElement(hardware_section, "System")
    SubElementText(system, "vssd:ElementName", "Virtual Hardware Family")
794
    SubElementText(system, "vssd:InstanceID", INSTANCE_ID["system"])
795
    SubElementText(system, "vssd:VirtualSystemIdentifier", name)
796
    SubElementText(system, "vssd:VirtualSystemType", self.virtual_system_type)
797 798 799 800

    # Item for vcpus
    vcpus_item = ET.SubElement(hardware_section, "Item")
    SubElementText(vcpus_item, "rasd:ElementName",
Iustin Pop's avatar
Iustin Pop committed
801
                   "%s virtual CPU(s)" % vcpus)
802
    SubElementText(vcpus_item, "rasd:InstanceID", INSTANCE_ID["vcpus"])
803 804 805 806 807 808 809
    SubElementText(vcpus_item, "rasd:ResourceType", RASD_TYPE["vcpus"])
    SubElementText(vcpus_item, "rasd:VirtualQuantity", vcpus)

    # Item for memory
    memory_item = ET.SubElement(hardware_section, "Item")
    SubElementText(memory_item, "rasd:AllocationUnits", "byte * 2^20")
    SubElementText(memory_item, "rasd:ElementName", "%sMB of memory" % memory)
810
    SubElementText(memory_item, "rasd:InstanceID", INSTANCE_ID["memory"])
811 812 813 814 815
    SubElementText(memory_item, "rasd:ResourceType", RASD_TYPE["memory"])
    SubElementText(memory_item, "rasd:VirtualQuantity", memory)

    # Item for scsi controller
    scsi_item = ET.SubElement(hardware_section, "Item")
816
    SubElementText(scsi_item, "rasd:Address", INSTANCE_ID["system"])
817
    SubElementText(scsi_item, "rasd:ElementName", "scsi_controller0")
818 819
    SubElementText(scsi_item, "rasd:InstanceID", INSTANCE_ID["scsi"])
    SubElementText(scsi_item, "rasd:ResourceSubType", SCSI_SUBTYPE)
820 821 822
    SubElementText(scsi_item, "rasd:ResourceType", RASD_TYPE["scsi-controller"])

    # Other items - from self.hardware_list
823
    for item in self.hardware_list:
824
      hardware_section.append(item)
825 826 827 828 829 830 831 832 833 834 835

  def PrettyXmlDump(self):
    """Formatter of the XML file.

    @rtype: string
    @return: XML tree in the form of nicely-formatted string

    """
    raw_string = ET.tostring(self.tree)
    parsed_xml = xml.dom.minidom.parseString(raw_string)
    xml_string = parsed_xml.toprettyxml(indent="  ")
Michele Tartara's avatar
Michele Tartara committed
836 837
    text_re = re.compile(r">\n\s+([^<>\s].*?)\n\s+</", re.DOTALL)
    return text_re.sub(r">\g<1></", xml_string)
838 839


840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
class Converter(object):
  """Converter class for OVF packages.

  Converter is a class above both ImporterOVF and ExporterOVF. It's purpose is
  to provide a common interface for the two.

  @type options: optparse.Values
  @ivar options: options parsed from the command line
  @type output_dir: string
  @ivar output_dir: directory to which the results of conversion shall be
    written
  @type temp_file_manager: L{utils.TemporaryFileManager}
  @ivar temp_file_manager: container for temporary files created during
    conversion
  @type temp_dir: string
  @ivar temp_dir: temporary directory created then we deal with OVA

  """
  def __init__(self, input_path, options):
    """Initialize the converter.

    @type input_path: string
    @param input_path: path to the Converter input file
    @type options: optparse.Values
    @param options: command line options

    @raise errors.OpPrereqError: if file does not exist

    """
    input_path = os.path.abspath(input_path)
    if not os.path.isfile(input_path):
871 872
      raise errors.OpPrereqError("File does not exist: %s" % input_path,
                                 errors.ECODE_ENVIRON)
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    self.options = options
    self.temp_file_manager = utils.TemporaryFileManager()
    self.temp_dir = None
    self.output_dir = None
    self._ReadInputData(input_path)

  def _ReadInputData(self, input_path):
    """Reads the data on which the conversion will take place.

    @type input_path: string
    @param input_path: absolute path to the Converter input file

    """
    raise NotImplementedError()

Agata Murawska's avatar
Agata Murawska committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
  def _CompressDisk(self, disk_path, compression, action):
    """Performs (de)compression on the disk and returns the new path

    @type disk_path: string
    @param disk_path: path to the disk
    @type compression: string
    @param compression: compression type
    @type action: string
    @param action: whether the action is compression or decompression
    @rtype: string
    @return: new disk path after (de)compression

    @raise errors.OpPrereqError: disk (de)compression failed or "compression"
      is not supported

    """
    assert(action in ALLOWED_ACTIONS)
    # For now we only support gzip, as it is used in ovftool
    if compression != COMPRESSION_TYPE:
      raise errors.OpPrereqError("Unsupported compression type: %s"
908
                                 % compression, errors.ECODE_INVAL)
Agata Murawska's avatar
Agata Murawska committed
909 910 911 912 913 914 915
    disk_file = os.path.basename(disk_path)
    if action == DECOMPRESS:
      (disk_name, _) = os.path.splitext(disk_file)
      prefix = disk_name
    elif action == COMPRESS:
      prefix = disk_file
    new_path = utils.GetClosedTempfile(suffix=COMPRESSION_EXT, prefix=prefix,
Iustin Pop's avatar
Iustin Pop committed
916
                                       dir=self.output_dir)
Agata Murawska's avatar
Agata Murawska committed
917 918 919 920 921
    self.temp_file_manager.Add(new_path)
    args = ["gzip", "-c", disk_path]
    run_result = utils.RunCmd(args, output=new_path)
    if run_result.failed:
      raise errors.OpPrereqError("Disk %s failed with output: %s"
922 923
                                 % (action, run_result.stderr),
                                 errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
    logging.info("The %s of the disk is completed", action)
    return (COMPRESSION_EXT, new_path)

  def _ConvertDisk(self, disk_format, disk_path):
    """Performes conversion to specified format.

    @type disk_format: string
    @param disk_format: format to which the disk should be converted
    @type disk_path: string
    @param disk_path: path to the disk that should be converted
    @rtype: string
    @return path to the output disk

    @raise errors.OpPrereqError: convertion of the disk failed

    """
940
    CheckQemuImg()
Agata Murawska's avatar
Agata Murawska committed
941 942 943 944 945 946
    disk_file = os.path.basename(disk_path)
    (disk_name, disk_extension) = os.path.splitext(disk_file)
    if disk_extension != disk_format:
      logging.warning("Conversion of disk image to %s format, this may take"
                      " a while", disk_format)

Iustin Pop's avatar
Iustin Pop committed
947 948
    new_disk_path = utils.GetClosedTempfile(
      suffix=".%s" % disk_format, prefix=disk_name, dir=self.output_dir)
Agata Murawska's avatar
Agata Murawska committed
949 950
    self.temp_file_manager.Add(new_disk_path)
    args = [
951
      constants.QEMUIMG_PATH,
Agata Murawska's avatar
Agata Murawska committed
952 953 954 955 956 957 958 959 960
      "convert",
      "-O",
      disk_format,
      disk_path,
      new_disk_path,
    ]
    run_result = utils.RunCmd(args, cwd=os.getcwd())
    if run_result.failed:
      raise errors.OpPrereqError("Convertion to %s failed, qemu-img output was"
961 962
                                 ": %s" % (disk_format, run_result.stderr),
                                 errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
    return (".%s" % disk_format, new_disk_path)

  @staticmethod
  def _GetDiskQemuInfo(disk_path, regexp):
    """Figures out some information of the disk using qemu-img.

    @type disk_path: string
    @param disk_path: path to the disk we want to know the format of
    @type regexp: string
    @param regexp: string that has to be matched, it has to contain one group
    @rtype: string
    @return: disk format

    @raise errors.OpPrereqError: format information cannot be retrieved

    """
979
    CheckQemuImg()
980
    args = [constants.QEMUIMG_PATH, "info", disk_path]
Agata Murawska's avatar
Agata Murawska committed
981 982 983
    run_result = utils.RunCmd(args, cwd=os.getcwd())
    if run_result.failed:
      raise errors.OpPrereqError("Gathering info about the disk using qemu-img"
984 985
                                 " failed, output was: %s" % run_result.stderr,
                                 errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
986 987 988 989 990 991 992
    result = run_result.output
    regexp = r"%s" % regexp
    match = re.search(regexp, result)
    if match:
      disk_format = match.group(1)
    else:
      raise errors.OpPrereqError("No file information matching %s found in:"
993 994
                                 " %s" % (regexp, result),
                                 errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
995 996
    return disk_format

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
  def Parse(self):
    """Parses the data and creates a structure containing all required info.

    """
    raise NotImplementedError()

  def Save(self):
    """Saves the gathered configuration in an apropriate format.

    """
    raise NotImplementedError()

  def Cleanup(self):
    """Cleans the temporary directory, if one was created.

    """
    self.temp_file_manager.Cleanup()
    if self.temp_dir:
      shutil.rmtree(self.temp_dir)
      self.temp_dir = None


class OVFImporter(Converter):
Agata Murawska's avatar
Agata Murawska committed
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  """Converter from OVF to Ganeti config file.

  @type input_dir: string
  @ivar input_dir: directory in which the .ovf file resides
  @type output_dir: string
  @ivar output_dir: directory to which the results of conversion shall be
    written
  @type input_path: string
  @ivar input_path: complete path to the .ovf file
  @type ovf_reader: L{OVFReader}
  @ivar ovf_reader: OVF reader instance collects data from .ovf file
Agata Murawska's avatar
Agata Murawska committed
1031 1032 1033 1034 1035
  @type results_name: string
  @ivar results_name: name of imported instance
  @type results_template: string
  @ivar results_template: disk template read from .ovf file or command line
    arguments
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
  @type results_hypervisor: dict
  @ivar results_hypervisor: hypervisor information gathered from .ovf file or
    command line arguments
  @type results_os: dict
  @ivar results_os: operating system information gathered from .ovf file or
    command line arguments
  @type results_backend: dict
  @ivar results_backend: backend information gathered from .ovf file or
    command line arguments
  @type results_tags: string
  @ivar results_tags: string containing instance-specific tags
  @type results_version: string
  @ivar results_version: version as required by Ganeti import
Agata Murawska's avatar
Agata Murawska committed
1049 1050 1051
  @type results_network: dict
  @ivar results_network: network information gathered from .ovf file or command
    line arguments
Agata Murawska's avatar
Agata Murawska committed
1052 1053 1054
  @type results_disk: dict
  @ivar results_disk: disk information gathered from .ovf file or command line
    arguments
Agata Murawska's avatar
Agata Murawska committed
1055 1056

  """
1057
  def _ReadInputData(self, input_path):
Agata Murawska's avatar
Agata Murawska committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    """Reads the data on which the conversion will take place.

    @type input_path: string
    @param input_path: absolute path to the .ovf or .ova input file

    @raise errors.OpPrereqError: if input file is neither .ovf nor .ova

    """
    (input_dir, input_file) = os.path.split(input_path)
    (_, input_extension) = os.path.splitext(input_file)

    if input_extension == OVF_EXT:
      logging.info("%s file extension found, no unpacking necessary", OVF_EXT)
      self.input_dir = input_dir
      self.input_path = input_path
      self.temp_dir = None
    elif input_extension == OVA_EXT:
      logging.info("%s file extension found, proceeding to unpacking", OVA_EXT)
      self._UnpackOVA(input_path)
    else:
      raise errors.OpPrereqError("Unknown file extension; expected %s or %s"
1079 1080
                                 " file" % (OVA_EXT, OVF_EXT),
                                 errors.ECODE_INVAL)
Agata Murawska's avatar
Agata Murawska committed
1081 1082 1083 1084 1085 1086
    assert ((input_extension == OVA_EXT and self.temp_dir) or
            (input_extension == OVF_EXT and not self.temp_dir))
    assert self.input_dir in self.input_path

    if self.options.output_dir:
      self.output_dir = os.path.abspath(self.options.output_dir)
1087 1088
      if (os.path.commonprefix([pathutils.EXPORT_DIR, self.output_dir]) !=
          pathutils.EXPORT_DIR):
Agata Murawska's avatar
Agata Murawska committed
1089 1090
        logging.warning("Export path is not under %s directory, import to"
                        " Ganeti using gnt-backup may fail",
1091
                        pathutils.EXPORT_DIR)
Agata Murawska's avatar
Agata Murawska committed
1092
    else:
1093
      self.output_dir = pathutils.EXPORT_DIR
Agata Murawska's avatar
Agata Murawska committed
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111

    self.ovf_reader = OVFReader(self.input_path)
    self.ovf_reader.VerifyManifest()

  def _UnpackOVA(self, input_path):
    """Unpacks the .ova package into temporary directory.

    @type input_path: string
    @param input_path: path to the .ova package file

    @raise errors.OpPrereqError: if file is not a proper tarball, one of the
        files in the archive seem malicious (e.g. path starts with '../') or
        .ova package does not contain .ovf file

    """
    input_name = None
    if not tarfile.is_tarfile(input_path):
      raise errors.OpPrereqError("The provided %s file is not a proper tar"
1112
                                 " archive" % OVA_EXT, errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
1113 1114 1115 1116 1117 1118 1119 1120 1121
    ova_content = tarfile.open(input_path)
    temp_dir = tempfile.mkdtemp()
    self.temp_dir = temp_dir
    for file_name in ova_content.getnames():
      file_normname = os.path.normpath(file_name)
      try:
        utils.PathJoin(temp_dir, file_normname)
      except ValueError, err:
        raise errors.OpPrereqError("File %s inside %s package is not safe" %
1122
                                   (file_name, OVA_EXT), errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
1123 1124 1125 1126
      if file_name.endswith(OVF_EXT):
        input_name = file_name
    if not input_name:
      raise errors.OpPrereqError("No %s file in %s package found" %
1127
                                 (OVF_EXT, OVA_EXT), errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
1128
    logging.warning("Unpacking the %s archive, this may take a while",
Iustin Pop's avatar
Iustin Pop committed
1129
                    input_path)
Agata Murawska's avatar
Agata Murawska committed
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
    self.input_dir = temp_dir
    self.input_path = utils.PathJoin(self.temp_dir, input_name)
    try:
      try:
        extract = ova_content.extractall
      except AttributeError:
        # This is a prehistorical case of using python < 2.5
        for member in ova_content.getmembers():
          ova_content.extract(member, path=self.temp_dir)
      else:
        extract(self.temp_dir)
    except tarfile.TarError, err:
      raise errors.OpPrereqError("Error while extracting %s archive: %s" %
1143
                                 (OVA_EXT, err), errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
1144
    logging.info("OVA package extracted to %s directory", self.temp_dir)
1145 1146

  def Parse(self):
Agata Murawska's avatar
Agata Murawska committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
    """Parses the data and creates a structure containing all required info.

    The method reads the information given either as a command line option or as
    a part of the OVF description.

    @raise errors.OpPrereqError: if some required part of the description of
      virtual instance is missing or unable to create output directory

    """
    self.results_name = self._GetInfo("instance name", self.options.name,
Iustin Pop's avatar
Iustin Pop committed
1157 1158
                                      self._ParseNameOptions,
                                      self.ovf_reader.GetInstanceName)
Agata Murawska's avatar
Agata Murawska committed
1159
    if not self.results_name:
1160 1161
      raise errors.OpPrereqError("Name of instance not provided",
                                 errors.ECODE_INVAL)
Agata Murawska's avatar
Agata Murawska committed
1162 1163 1164 1165 1166 1167

    self.output_dir = utils.PathJoin(self.output_dir, self.results_name)
    try:
      utils.Makedirs(self.output_dir)
    except OSError, err:
      raise errors.OpPrereqError("Failed to create directory %s: %s" %
1168
                                 (self.output_dir, err), errors.ECODE_ENVIRON)
Agata Murawska's avatar
Agata Murawska committed
1169

Iustin Pop's avatar
Iustin Pop committed
1170 1171
    self.results_template = self._GetInfo(
      "disk template", self.options.disk_template, self._ParseTemplateOptions,
Agata Murawska's avatar
Agata Murawska committed
1172 1173 1174 1175
      self.ovf_reader.GetDiskTemplate)
    if not self.results_template:
      logging.info("Disk template not given")

Iustin Pop's avatar
Iustin Pop committed
1176 1177
    self.results_hypervisor = self._GetInfo(
      "hypervisor", self.options.hypervisor, self._ParseHypervisorOptions,
1178 1179 1180 1181 1182
      self.ovf_reader.GetHypervisorData)
    assert self.results_hypervisor["hypervisor_name"]
    if self.results_hypervisor["hypervisor_name"] == constants.VALUE_AUTO:
      logging.debug("Default hypervisor settings from the cluster will be used")

Iustin Pop's avatar
Iustin Pop committed
1183 1184
    self.results_os = self._GetInfo(
      "OS", self.options.os, self._ParseOSOptions, self.ovf_reader.GetOSData)
1185
    if not self.results_os.get("os_name"):
1186 1187
      raise errors.OpPrereqError("OS name must be provided",
                                 errors.ECODE_INVAL)
1188

Iustin Pop's avatar
Iustin Pop committed
1189 1190
    self.results_backend = self._GetInfo(
      "backend", self.options.beparams,
1191 1192 1193 1194 1195
      self._ParseBackendOptions, self.ovf_reader.GetBackendData)
    assert self.results_backend.get("vcpus")
    assert self.results_backend.get("memory")
    assert self.results_backend.get("auto_balance") is not None

Iustin Pop's avatar
Iustin Pop committed
1196 1197
    self.results_tags = self._GetInfo(
      "tags", self.options.tags, self._ParseTags, self.ovf_reader.GetTagsData)
1198 1199 1200 1201 1202 1203 1204

    ovf_version = self.ovf_reader.GetVersionData()
    if ovf_version:
      self.results_version = ovf_version
    else:
      self.results_version = constants.EXPORT_VERSION

Iustin Pop's avatar
Iustin Pop committed
1205 1206 1207
    self.results_network = self._GetInfo(
      "network", self.options.nics, self._ParseNicOptions,
      self.ovf_reader.GetNetworkData, ignore_test=self.options.no_nics)
Agata Murawska's avatar
Agata Murawska committed
1208

Iustin Pop's avatar
Iustin Pop committed
1209 1210
    self.results_disk = self._GetInfo(
      "disk", self.options.disks, self._ParseDiskOptions, self._GetDiskInfo,
Agata Murawska's avatar
Agata Murawska committed
1211 1212
      ignore_test=self.results_template == constants.DT_DISKLESS)

Agata Murawska's avatar
Agata Murawska committed
1213 1214
    if not self.results_disk and not self.results_network:
      raise errors.OpPrereqError("Either disk specification or network"
1215 1216
                                 " description must be present",
                                 errors.ECODE_STATE)
Agata Murawska's avatar
Agata Murawska committed
1217

Agata Murawska's avatar
Agata Murawska committed
1218 1219
  @staticmethod
  def _GetInfo(name, cmd_arg, cmd_function, nocmd_function,
Iustin Pop's avatar
Iustin Pop committed
1220
               ignore_test=False):
Agata Murawska's avatar
Agata Murawska committed
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
    """Get information about some section - e.g. disk, network, hypervisor.

    @type name: string
    @param name: name of the section
    @type cmd_arg: dict
    @param cmd_arg: command line argument specific for section 'name'
    @type cmd_function: callable
    @param cmd_function: function to call if 'cmd_args' exists
    @type nocmd_function: callable
    @param nocmd_function: function to call if 'cmd_args' is not there

    """
    if ignore_test:
      logging.info("Information for %s will be ignored", name)
      return {}
    if cmd_arg:
      logging.info("Information for %s will be parsed from command line", name)
      results = cmd_function()
    else:
      logging.info("Information for %s will be parsed from %s file",
Iustin Pop's avatar
Iustin Pop committed
1241
                   name, OVF_EXT)
Agata Murawska's avatar
Agata Murawska committed
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
      results = nocmd_function()
    logging.info("Options for %s were succesfully read", name)
    return results

  def _ParseNameOptions(self):
    """Returns name if one was given in command line.

    @rtype: string
    @return: name of an instance

    """
    return self.options.name

  def _ParseTemplateOptions(self):
    """Returns disk template if one was given in command line.

    @rtype: string
    @return: disk template name

    """
    return self.options.disk_template

1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309