format.py 42.2 KB
Newer Older
Łukasz Nowak's avatar
Łukasz Nowak committed
1 2 3
# -*- coding: utf-8 -*-
##############################################################################
#
4 5
# Copyright (c) 2010, 2011, 2012 Vifib SARL and Contributors.
# All Rights Reserved.
Łukasz Nowak's avatar
Łukasz Nowak committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly advised to contract a Free Software
# Service Company
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
29

Łukasz Nowak's avatar
Łukasz Nowak committed
30 31 32 33 34 35 36 37
from optparse import OptionParser, Option
from xml_marshaller import xml_marshaller
import ConfigParser
import grp
import logging
import netaddr
import netifaces
import os
Łukasz Nowak's avatar
Łukasz Nowak committed
38
import pwd
Łukasz Nowak's avatar
Łukasz Nowak committed
39 40 41 42 43 44 45
import random
import slapos.slap as slap
import socket
import subprocess
import sys
import time

Vincent Pelletier's avatar
Vincent Pelletier committed
46 47 48 49
class OS(object):
  _os = os

  def __init__(self, config):
50
    self._dry_run = config.dry_run
Vincent Pelletier's avatar
Vincent Pelletier committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
    self._verbose = config.verbose
    self._logger = config.logger
    add = self._addWrapper
    add('chown')
    add('chmod')
    add('makedirs')
    add('mkdir')

  def _addWrapper(self, name):
    def wrapper(*args, **kw):
      if self._verbose:
        arg_list = [repr(x) for x in args] + [
          '%s=%r' % (x, y) for x, y in kw.iteritems()]
        self._logger.debug('%s(%s)' % (
          name,
          ', '.join(arg_list)
        ))
68 69
      if not self._dry_run:
        getattr(self._os, name)(*args, **kw)
Vincent Pelletier's avatar
Vincent Pelletier committed
70 71 72 73
    setattr(self, name, wrapper)

  def __getattr__(self, name):
    return getattr(self._os, name)
Łukasz Nowak's avatar
Łukasz Nowak committed
74

75 76 77
class UsageError(Exception):
  pass

78
class NoAddressOnInterface(Exception):
Łukasz Nowak's avatar
Łukasz Nowak committed
79
  """
80
  Exception raised if there's not address on the interface to construct IPv6
81 82 83
  address with.

  Attributes:
84
    brige: String, the name of the interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
85 86
  """

87 88 89
  def __init__(self, interface):
    super(NoAddressOnInterface, self).__init__(
      'No IPv6 found on interface %s to construct IPv6 with.' % (interface, )
90
    )
Łukasz Nowak's avatar
Łukasz Nowak committed
91

92 93 94
class AddressGenerationError(Exception):
  """
  Exception raised if the generation of an IPv6 based on the prefix obtained
95
  from the interface failed.
96 97 98 99 100 101 102 103

  Attributes:
    addr: String, the invalid address the exception is raised for.
  """
  def __init__(self, addr):
    super(AddressGenerationError, self).__init__(
      'Generated IPv6 %s seems not to be a valid IP.' % addr
    )
Łukasz Nowak's avatar
Łukasz Nowak committed
104 105 106 107 108 109

def callAndRead(argument_list, raise_on_error=True):
  popen = subprocess.Popen(argument_list, stdout=subprocess.PIPE,
      stderr=subprocess.STDOUT)
  result = popen.communicate()[0]
  if raise_on_error and popen.returncode != 0:
Vincent Pelletier's avatar
Vincent Pelletier committed
110 111
    raise ValueError('Issue during invoking %r, result was:\n%s' % (
      argument_list, result))
Łukasz Nowak's avatar
Łukasz Nowak committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
  return popen.returncode, result

def isGlobalScopeAddress(a):
  """Returns True if a is global scope IP v4/6 address"""
  ip = netaddr.IPAddress(a)
  return not ip.is_link_local() and not ip.is_loopback() and \
      not ip.is_reserved() and ip.is_unicast()

def netmaskToPrefixIPv4(netmask):
  """Convert string represented netmask to its integer prefix"""
  return netaddr.strategy.ipv4.netmask_to_prefix[
          netaddr.strategy.ipv4.str_to_int(netmask)]

def netmaskToPrefixIPv6(netmask):
  """Convert string represented netmask to its integer prefix"""
  return netaddr.strategy.ipv6.netmask_to_prefix[
          netaddr.strategy.ipv6.str_to_int(netmask)]

def _getDict(instance):
  """
  Serialize an object instance into dictionaries. List and dict will remains
  the same, basic type too. But encapsulated object will be returned as dict.
  Set, collections and other aren't handle for now.

  Args:
    instance: an object of any type.

  Returns:
    A dictionary if the given object wasn't a list, a list otherwise.
  """
  if isinstance(instance, list):
    return [_getDict(item) for item in instance]

  elif isinstance(instance, dict):
    result = {}
147
    for key in instance:
Łukasz Nowak's avatar
Łukasz Nowak committed
148 149 150 151 152
      result[key] = _getDict(instance[key])
    return result

  else:
    try:
153
      dikt = instance.__dict__
Łukasz Nowak's avatar
Łukasz Nowak committed
154 155
    except AttributeError:
      return instance
156 157 158 159
    result = {}
    for key, value in dikt.iteritems():
      result[key] = _getDict(value)
    return result
Łukasz Nowak's avatar
Łukasz Nowak committed
160

161
class Computer(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
162
  "Object representing the computer"
163 164
  instance_root = None
  software_root = None
Łukasz Nowak's avatar
Łukasz Nowak committed
165

166
  def __init__(self, reference, interface=None, addr=None, netmask=None,
167
    ipv6_interface=None, software_user='slapsoft'):
Łukasz Nowak's avatar
Łukasz Nowak committed
168 169 170
    """
    Attributes:
      reference: String, the reference of the computer.
171
      interface: String, the name of the computer's used interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
172 173
    """
    self.reference = str(reference)
174
    self.interface = interface
Łukasz Nowak's avatar
Łukasz Nowak committed
175 176 177
    self.partition_list = []
    self.address = addr
    self.netmask = netmask
178
    self.ipv6_interface = ipv6_interface
179
    self.software_user = software_user
Łukasz Nowak's avatar
Łukasz Nowak committed
180 181

  def __getinitargs__(self):
182
    return (self.reference, self.interface)
Łukasz Nowak's avatar
Łukasz Nowak committed
183

184
  def getAddress(self, allow_tap=False):
Łukasz Nowak's avatar
Łukasz Nowak committed
185
    """
186
    Return a list of the interface address not attributed to any partition, (which
Łukasz Nowak's avatar
Łukasz Nowak committed
187 188 189
    are therefore free for the computer itself).

    Returns:
190
      False if the interface isn't available, else the list of the free addresses.
Łukasz Nowak's avatar
Łukasz Nowak committed
191
    """
192
    if self.interface is None:
Łukasz Nowak's avatar
Łukasz Nowak committed
193 194 195 196 197 198 199
      return dict(addr=self.address, netmask=self.netmask)

    computer_partition_address_list = []
    for partition in self.partition_list:
      for address in partition.address_list:
        if netaddr.valid_ipv6(address['addr']):
          computer_partition_address_list.append(address['addr'])
200
    # Going through addresses of the computer's interface
201
    for address_dict in self.interface.getGlobalScopeAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
202 203 204 205
      # Comparing with computer's partition addresses
      if address_dict['addr'] not in computer_partition_address_list:
        return address_dict

206
    if allow_tap:
207 208 209 210 211 212 213
      # all addresses on interface are for partition, so lets add new one
      computer_tap = Tap('compdummy')
      computer_tap.createWithOwner(User('root'), attach_to_tap=True)
      self.interface.addTap(computer_tap)
      return self.interface.addAddr()

    # Can't find address
214
    raise NoAddressOnInterface('No valid IPv6 found on %s.' %
215
        self.interface.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

  def send(self, config):
    """
    Send a marshalled dictionary of the computer object serialized via_getDict.
    """

    slap_instance = slap.slap()
    connection_dict = {}
    if config.key_file and config.cert_file:
      connection_dict.update(
        key_file=config.key_file,
        cert_file=config.cert_file)
    slap_instance.initializeConnection(config.master_url,
      **connection_dict)
    slap_computer = slap_instance.registerComputer(self.reference)
231 232
    if config.dry_run:
      return
233 234 235 236 237 238 239
    try:
      response = slap_computer.updateConfiguration(
          xml_marshaller.dumps(_getDict(self)))
    except slap.NotFoundError as error:
      raise slap.NotFoundError("%s\nERROR : This SlapOS node is not recognised by "
          "SlapOS Master. Please make sure computer_id of slapos.cfg looks "
          "like 'COMP-123' and is correct.\nError is : 404 Not Found." % error)
240
    return
Łukasz Nowak's avatar
Łukasz Nowak committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

  def dump(self, path_to_xml):
    """
    Dump the computer object to an xml file via xml_marshaller.

    Args:
      path_to_xml: String, path to the file to load.
      users: List of User, list of user needed to be add to the dump
          (even if they are not related to any tap interface).
    """

    computer_dict = _getDict(self)
    output_file = open(path_to_xml,'w')
    output_file.write(xml_marshaller.dumps(computer_dict))
    output_file.close()

  @classmethod
258
  def load(cls, path_to_xml, reference, ipv6_interface):
Łukasz Nowak's avatar
Łukasz Nowak committed
259 260 261 262 263 264 265 266
    """
    Create a computer object from a valid xml file.

    Arg:
      path_to_xml: String, a path to a valid file containing
          a valid configuration.

    Return:
267
      A Computer object.
Łukasz Nowak's avatar
Łukasz Nowak committed
268 269 270 271 272 273 274 275 276
    """

    dumped_dict = xml_marshaller.loads(open(path_to_xml).read())

    # Reconstructing the computer object from the xml
    computer = Computer(
        reference = reference,
        addr = dumped_dict['address'],
        netmask = dumped_dict['netmask'],
277
        ipv6_interface=ipv6_interface,
278
        software_user=dumped_dict.get('software_user', 'slapsoft'),
Łukasz Nowak's avatar
Łukasz Nowak committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    )

    for partition_dict in dumped_dict['partition_list']:

      if partition_dict['user']:
        user = User(partition_dict['user']['name'])
      else:
        user = User('root')

      if partition_dict['tap']:
        tap = Tap(partition_dict['tap']['name'])
      else:
        tap = Tap(partition_dict['reference'])

      address_list = partition_dict['address_list']

      partition = Partition(
          reference = partition_dict['reference'],
          path = partition_dict['path'],
          user = user,
          address_list = address_list,
          tap = tap,
      )

      computer.partition_list.append(partition)

    return computer

307
  def construct(self, alter_user=True, alter_network=True, create_tap=True):
Łukasz Nowak's avatar
Łukasz Nowak committed
308 309 310 311
    """
    Construct the computer object as it is.
    """
    if alter_network and self.address is not None:
312
      self.interface.addAddr(self.address, self.netmask)
Łukasz Nowak's avatar
Łukasz Nowak committed
313

314
    for path in self.instance_root, self.software_root:
Łukasz Nowak's avatar
Łukasz Nowak committed
315 316 317 318 319
      if not os.path.exists(path):
        os.makedirs(path, 0755)
      else:
        os.chmod(path, 0755)

320 321
    # own self.software_root by software user
    slapsoft = User(self.software_user)
Łukasz Nowak's avatar
Łukasz Nowak committed
322 323 324
    slapsoft.path = self.software_root
    if alter_user:
      slapsoft.create()
Łukasz Nowak's avatar
Łukasz Nowak committed
325
      slapsoft_pw = pwd.getpwnam(slapsoft.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
326 327 328
      os.chown(self.software_root, slapsoft_pw.pw_uid, slapsoft_pw.pw_gid)
    os.chmod(self.software_root, 0755)

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    try:
      for partition_index, partition in enumerate(self.partition_list):
        # Reconstructing User's
        partition.path = os.path.join(self.instance_root, partition.reference)
        partition.user.setPath(partition.path)
        partition.user.additional_group_list = [slapsoft.name]
        if alter_user:
          partition.user.create()

        # Reconstructing Tap
        if partition.user and partition.user.isAvailable():
          owner = partition.user
        else:
          owner = User('root')

344
        if alter_network and create_tap:
345
          # In case it has to be  attached to the TAP network device, only one
346 347
          # is necessary for the interface to assert carrier
          if self.interface.attach_to_tap and partition_index == 0:
348
            partition.tap.createWithOwner(owner, attach_to_tap=True)
Łukasz Nowak's avatar
Łukasz Nowak committed
349
          else:
350 351
            partition.tap.createWithOwner(owner)

352
          self.interface.addTap(partition.tap)
353 354 355 356 357 358 359 360 361 362

        # Reconstructing partition's directory
        partition.createPath(alter_user)

        # Reconstructing partition's address
        # There should be two addresses on each Computer Partition:
        #  * global IPv6
        #  * local IPv4, took from slapformat:ipv4_local_network
        if len(partition.address_list) == 0:
          # regenerate
363 364
          partition.address_list.append(self.interface.addIPv4LocalAddress())
          partition.address_list.append(self.interface.addAddr())
365 366 367 368 369
        elif alter_network:
          # regenerate list of addresses
          old_partition_address_list = partition.address_list
          partition.address_list = []
          if len(old_partition_address_list) != 2:
370 371 372
            raise ValueError(
              'There should be exactly 2 stored addresses. Got: %r' %
              (old_partition_address_list,))
Vincent Pelletier's avatar
Vincent Pelletier committed
373 374
          if not any([netaddr.valid_ipv6(q['addr'])
              for q in old_partition_address_list]):
375
            raise ValueError('Not valid ipv6 addresses loaded')
Vincent Pelletier's avatar
Vincent Pelletier committed
376 377
          if not any([netaddr.valid_ipv4(q['addr'])
              for q in old_partition_address_list]):
378 379 380
            raise ValueError('Not valid ipv6 addresses loaded')
          for address in old_partition_address_list:
            if netaddr.valid_ipv6(address['addr']):
381
              partition.address_list.append(self.interface.addAddr(
Vincent Pelletier's avatar
Vincent Pelletier committed
382 383
                address['addr'],
                address['netmask']))
384
            elif netaddr.valid_ipv4(address['addr']):
385
              partition.address_list.append(self.interface.addIPv4LocalAddress(
Vincent Pelletier's avatar
Vincent Pelletier committed
386
                address['addr']))
387 388 389
            else:
              raise ValueError('Address %r is incorrect' % address['addr'])
    finally:
390
      if alter_network and create_tap and self.interface.attach_to_tap:
391 392 393 394
        try:
          self.partition_list[0].tap.detach()
        except IndexError:
          pass
Łukasz Nowak's avatar
Łukasz Nowak committed
395

396
class Partition(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
  "Represent a computer partition"

  def __init__(self, reference, path, user, address_list, tap):
    """
    Attributes:
      reference: String, the name of the partition.
      path: String, the path to the partition folder.
      user: User, the user linked to this partition.
      address_list: List of associated IP addresses.
      tap: Tap, the tap interface linked to this partition.
    """

    self.reference = str(reference)
    self.path = str(path)
    self.user = user
    self.address_list = address_list or []
    self.tap = tap

  def __getinitargs__(self):
    return (self.reference, self.path, self.user, self.address_list, self.tap)

  def createPath(self, alter_user=True):
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
420 421
    Create the directory of the partition, assign to the partition user and
    give it the 750 permission. In case if path exists just modifies it.
Łukasz Nowak's avatar
Łukasz Nowak committed
422 423
    """

424
    self.path = os.path.abspath(self.path)
Łukasz Nowak's avatar
Łukasz Nowak committed
425
    owner = self.user if self.user else User('root')
426 427
    if not os.path.exists(self.path):
      os.mkdir(self.path, 0750)
Łukasz Nowak's avatar
Łukasz Nowak committed
428
    if alter_user:
Łukasz Nowak's avatar
Łukasz Nowak committed
429
      owner_pw = pwd.getpwnam(owner.name)
430 431
      os.chown(self.path, owner_pw.pw_uid, owner_pw.pw_gid)
    os.chmod(self.path, 0750)
Łukasz Nowak's avatar
Łukasz Nowak committed
432

433
class User(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
434
  "User: represent and manipulate a user on the system."
435
  path = None
Łukasz Nowak's avatar
Łukasz Nowak committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462

  def __init__(self, user_name, additional_group_list=None):
    """
    Attributes:
        user_name: string, the name of the user, who will have is home in
    """
    self.name = str(user_name)
    self.additional_group_list = additional_group_list

  def __getinitargs__(self):
    return (self.name,)

  def setPath(self, path):
    self.path = path

  def create(self):
    """
    Create a user on the system who will be named after the self.name with its
    own group and directory.

    Returns:
        True: if the user creation went right
    """
    # XXX: This method shall be no-op in case if all is correctly setup
    #      This method shall check if all is correctly done
    #      This method shall not reset groups, just add them
    try:
463
      grp.getgrnam(self.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
464 465 466
    except KeyError:
      callAndRead(['groupadd', self.name])

Vincent Pelletier's avatar
Vincent Pelletier committed
467 468
    user_parameter_list = ['-d', self.path, '-g', self.name, '-s',
      '/bin/false']
Łukasz Nowak's avatar
Łukasz Nowak committed
469 470 471 472
    if self.additional_group_list is not None:
      user_parameter_list.extend(['-G', ','.join(self.additional_group_list)])
    user_parameter_list.append(self.name)
    try:
Łukasz Nowak's avatar
Łukasz Nowak committed
473
      pwd.getpwnam(self.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
474
    except KeyError:
475
      user_parameter_list.append('-r')
Łukasz Nowak's avatar
Łukasz Nowak committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
      callAndRead(['useradd'] + user_parameter_list)
    else:
      callAndRead(['usermod'] + user_parameter_list)

    return True

  def isAvailable(self):
    """
    Determine the availability of a user on the system

    Return:
        True: if available
        False: otherwise
    """

    try:
Łukasz Nowak's avatar
Łukasz Nowak committed
492
      pwd.getpwnam(self.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
493 494 495 496 497
      return True

    except KeyError:
      return False

498 499 500 501 502
import struct
import fcntl
import errno
import threading

503
class Tap(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
504
  "Tap represent a tap interface on the system"
505 506 507
  IFF_TAP = 0x0002
  TUNSETIFF = 0x400454ca
  KEEP_TAP_ATTACHED_EVENT = threading.Event()
Łukasz Nowak's avatar
Łukasz Nowak committed
508 509 510 511 512 513 514 515 516 517 518 519

  def __init__(self, tap_name):
    """
    Attributes:
        tap_name: String, the name of the tap interface.
    """

    self.name = str(tap_name)

  def __getinitargs__(self):
    return (self.name,)

520 521 522 523 524 525 526 527 528 529 530 531
  def attach(self):
    """
    Attach to the TAP interface, meaning  that it just opens the TAP interface
    and wait for the caller to notify that it can be safely detached.

    Linux  distinguishes administrative  and operational  state of  an network
    interface.  The  former can be set  manually by running ``ip  link set dev
    <dev> up|down'', whereas the latter states that the interface can actually
    transmit  data (for  a wired  network interface,  it basically  means that
    there is  carrier, e.g.  the network  cable is plugged  into a  switch for
    example).

532
    In case of bridge:
533 534 535 536 537 538 539 540 541 542 543 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 572
    In order  to be able to check  the uniqueness of IPv6  address assigned to
    the bridge, the network interface  must be up from an administrative *and*
    operational point of view.

    However,  from  Linux  2.6.39,  the  bridge  reflects  the  state  of  the
    underlying device (e.g.  the bridge asserts carrier if at least one of its
    ports has carrier) whereas it  always asserted carrier before. This should
    work fine for "real" network interface,  but will not work properly if the
    bridge only binds TAP interfaces, which, from 2.6.36, reports carrier only
    and only if an userspace program is attached.
    """
    tap_fd = os.open("/dev/net/tun", os.O_RDWR)

    try:
      # Attach to the TAP interface which has previously been created
      fcntl.ioctl(tap_fd, self.TUNSETIFF,
                  struct.pack("16sI", self.name, self.IFF_TAP))

    except IOError, error:
      # If  EBUSY, it  means another  program is  already attached,  thus just
      # ignore it...
      if error.errno != errno.EBUSY:
        os.close(tap_fd)
        raise
    else:
      # Block until the  caller send an event stating that  the program can be
      # now detached safely,  thus bringing down the TAP  device (from 2.6.36)
      # and the bridge at the same time (from 2.6.39)
      self.KEEP_TAP_ATTACHED_EVENT.wait()
    finally:
      os.close(tap_fd)

  def detach(self):
    """
    Detach to the  TAP network interface by notifying  the thread which attach
    to the TAP and closing the TAP file descriptor
    """
    self.KEEP_TAP_ATTACHED_EVENT.set()

  def createWithOwner(self, owner, attach_to_tap=False):
Łukasz Nowak's avatar
Łukasz Nowak committed
573 574 575 576 577 578 579 580 581
    """
    Create a tap interface on the system.
    """

    # some systems does not have -p switch for tunctl
    #callAndRead(['tunctl', '-p', '-t', self.name, '-u', owner.name])
    check_file = '/sys/devices/virtual/net/%s/owner' % self.name
    owner_id = None
    if os.path.exists(check_file):
582
      owner_id = open(check_file).read().strip()
Łukasz Nowak's avatar
Łukasz Nowak committed
583
      try:
584 585
        owner_id = int(owner_id)
      except ValueError:
Łukasz Nowak's avatar
Łukasz Nowak committed
586
        pass
587
    if owner_id != pwd.getpwnam(owner.name).pw_uid:
Łukasz Nowak's avatar
Łukasz Nowak committed
588 589 590
      callAndRead(['tunctl', '-t', self.name, '-u', owner.name])
    callAndRead(['ip', 'link', 'set', self.name, 'up'])

591 592 593
    if attach_to_tap:
      threading.Thread(target=self.attach).start()

594 595
class Interface(object):
  "Interface represent a interface on the system"
Łukasz Nowak's avatar
Łukasz Nowak committed
596

597
  def __init__(self, name, ipv4_local_network, ipv6_interface=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
598 599
    """
    Attributes:
600
        name: String, the name of the interface
Łukasz Nowak's avatar
Łukasz Nowak committed
601 602 603 604
    """

    self.name = str(name)
    self.ipv4_local_network = ipv4_local_network
605
    self.ipv6_interface = ipv6_interface
Łukasz Nowak's avatar
Łukasz Nowak committed
606

607
    # Attach to TAP  network interface, only if the  interface interface does not
608
    # report carrier
609
    _, result = callAndRead(['ip', 'addr', 'list', self.name])
610 611
    self.attach_to_tap = 'DOWN' in result.split('\n', 1)[0]

Łukasz Nowak's avatar
Łukasz Nowak committed
612 613 614 615
  def __getinitargs__(self):
    return (self.name,)

  def getIPv4LocalAddressList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
616 617 618 619
    """
    Returns currently configured local IPv4 addresses which are in
    ipv4_local_network
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
620 621 622 623 624 625 626 627 628
    if not socket.AF_INET in netifaces.ifaddresses(self.name):
      return []
    return [dict(addr=q['addr'], netmask=q['netmask']) for q in
      netifaces.ifaddresses(self.name)[socket.AF_INET] if netaddr.IPAddress(
        q['addr'], 4) in netaddr.glob_to_iprange(
          netaddr.cidr_to_glob(self.ipv4_local_network))]

  def getGlobalScopeAddressList(self):
    """Returns currently configured global scope IPv6 addresses"""
629 630 631 632
    if self.ipv6_interface:
      interface_name = self.ipv6_interface
    else:
      interface_name = self.name
633
    try:
Vincent Pelletier's avatar
Vincent Pelletier committed
634 635 636
      address_list = [q
        for q in netifaces.ifaddresses(interface_name)[socket.AF_INET6]
        if isGlobalScopeAddress(q['addr'].split('%')[0])]
637 638
    except KeyError:
      raise ValueError("%s must have at least one IPv6 address assigned" % \
639
                         interface_name)
Łukasz Nowak's avatar
Łukasz Nowak committed
640 641 642 643 644 645 646 647 648 649
    # XXX: Missing implementation of Unique Local IPv6 Unicast Addresses as
    # defined in http://www.rfc-editor.org/rfc/rfc4193.txt
    # XXX: XXX: XXX: IT IS DISALLOWED TO IMPLEMENT link-local addresses as
    # Linux and BSD are possibly wrongly implementing it -- it is "too local"
    # it is impossible to listen or access it on same node
    # XXX: IT IS DISALLOWED to implement ad hoc solution like inventing node
    # local addresses or anything which does not exists in RFC!
    return address_list

  def getInterfaceList(self):
650
    """Returns list of interfaces already present on bridge"""
Łukasz Nowak's avatar
Łukasz Nowak committed
651
    interface_list = []
652
    _, result = callAndRead(['brctl', 'show'])
653
    in_interface = False
Łukasz Nowak's avatar
Łukasz Nowak committed
654 655 656 657
    for line in result.split('\n'):
      if len(line.split()) > 1:
        if self.name in line:
          interface_list.append(line.split()[-1])
658
          in_interface = True
Łukasz Nowak's avatar
Łukasz Nowak committed
659
          continue
660
        if in_interface:
Łukasz Nowak's avatar
Łukasz Nowak committed
661
          break
662
      elif in_interface:
Łukasz Nowak's avatar
Łukasz Nowak committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
        if line.strip():
          interface_list.append(line.strip())

    return interface_list

  def addTap(self, tap):
    """
    Add the tap interface tap to the bridge.

    Args:
      tap: Tap, the tap interface.
    """
    if tap.name not in self.getInterfaceList():
      callAndRead(['brctl', 'addif', self.name, tap.name])

  def _addSystemAddress(self, address, netmask, ipv6=True):
679
    """Adds system address to interface
680

Łukasz Nowak's avatar
Łukasz Nowak committed
681 682 683 684 685 686 687
    Returns True if address was added successfully.

    Returns False if there was issue.
    """
    if ipv6:
      address_string = '%s/%s' % (address, netmaskToPrefixIPv6(netmask))
      af = socket.AF_INET6
688 689 690 691
      if self.ipv6_interface:
        interface_name = self.ipv6_interface
      else:
        interface_name = self.name
Łukasz Nowak's avatar
Łukasz Nowak committed
692 693 694
    else:
      af = socket.AF_INET
      address_string = '%s/%s' % (address, netmaskToPrefixIPv4(netmask))
695
      interface_name = self.name
Łukasz Nowak's avatar
Łukasz Nowak committed
696 697 698

    # check if address is already took by any other interface
    for interface in netifaces.interfaces():
699
      if interface != interface_name:
Łukasz Nowak's avatar
Łukasz Nowak committed
700 701
        address_dict = netifaces.ifaddresses(interface)
        if af in address_dict:
702
          if address in [q['addr'].split('%')[0] for q in address_dict[af]]:
Łukasz Nowak's avatar
Łukasz Nowak committed
703 704
            return False

Vincent Pelletier's avatar
Vincent Pelletier committed
705 706 707
    if not af in netifaces.ifaddresses(interface_name) \
        or not address in [q['addr'].split('%')[0]
          for q in netifaces.ifaddresses(interface_name)[af]]:
Łukasz Nowak's avatar
Łukasz Nowak committed
708
      # add an address
709
      callAndRead(['ip', 'addr', 'add', address_string, 'dev', interface_name])
710 711 712 713 714

      # Fake success for local ipv4
      if not ipv6:
        return True

Łukasz Nowak's avatar
Łukasz Nowak committed
715 716 717
      # wait few moments
      time.sleep(2)
    # check existence on interface
718
    _, result = callAndRead(['ip', 'addr', 'list', interface_name])
Łukasz Nowak's avatar
Łukasz Nowak committed
719 720 721 722
    for l in result.split('\n'):
      if address in l:
        if 'tentative' in l:
          # duplicate, remove
723 724
          callAndRead(['ip', 'addr', 'del', address_string, 'dev',
            interface_name])
Łukasz Nowak's avatar
Łukasz Nowak committed
725 726 727 728 729 730 731 732 733 734 735 736 737
          return False
        # found and clean
        return True
    # even when added not found, this is bad...
    return False

  def _generateRandomIPv4Address(self, netmask):
    # no addresses found, generate new one
    # Try 10 times to add address, raise in case if not possible
    try_num = 10
    while try_num > 0:
      addr = random.choice([q for q in netaddr.glob_to_iprange(
        netaddr.cidr_to_glob(self.ipv4_local_network))]).format()
Vincent Pelletier's avatar
Vincent Pelletier committed
738 739
      if dict(addr=addr, netmask=netmask) not in \
          self.getIPv4LocalAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753
        # Checking the validity of the IPv6 address
        if self._addSystemAddress(addr, netmask, False):
          return dict(addr=addr, netmask=netmask)
        try_num -= 1

    raise AddressGenerationError(addr)

  def addIPv4LocalAddress(self, addr=None):
    """Adds local IPv4 address in ipv4_local_network"""
    netmask = '255.255.255.255'
    local_address_list = self.getIPv4LocalAddressList()
    if addr is None:
      return self._generateRandomIPv4Address(netmask)
    elif dict(addr=addr, netmask=netmask) not in local_address_list:
754 755 756 757
      if self._addSystemAddress(addr, netmask, False):
        return dict(addr=addr, netmask=netmask)
      else:
        return self._generateRandomIPv4Address(netmask)
Łukasz Nowak's avatar
Łukasz Nowak committed
758 759 760 761 762 763
    else:
      # confirmed to be configured
      return dict(addr=addr, netmask=netmask)

  def addAddr(self, addr = None, netmask = None):
    """
764
    Adds IP address to interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
765

766
    If addr is specified and exists already on interface does nothing.
Łukasz Nowak's avatar
Łukasz Nowak committed
767

768
    If addr is specified and does not exists on interface, tries to add given
Vincent Pelletier's avatar
Vincent Pelletier committed
769 770
    address. If it is not possible (ex. because network changed) calculates new
    address.
Łukasz Nowak's avatar
Łukasz Nowak committed
771 772

    Args:
773
      addr: Wished address to be added to interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
774 775 776 777 778 779 780
      netmask: Wished netmask to be used.

    Returns:
      Tuple of (address, netmask).

    Raises:
      AddressGenerationError: Couldn't construct valid address with existing
781 782
          one's on the interface.
      NoAddressOnInterface: There's no address on the interface to construct
Łukasz Nowak's avatar
Łukasz Nowak committed
783 784
          an address with.
    """
785
    # Getting one address of the interface as base of the next addresses
786 787 788 789
    if self.ipv6_interface:
      interface_name = self.ipv6_interface
    else:
      interface_name = self.name
790
    interface_addr_list = self.getGlobalScopeAddressList()
Łukasz Nowak's avatar
Łukasz Nowak committed
791 792

    # No address found
793 794 795
    if len(interface_addr_list) == 0:
      raise NoAddressOnInterface(interface_name)
    address_dict = interface_addr_list[0]
Łukasz Nowak's avatar
Łukasz Nowak committed
796 797

    if addr is not None:
798
      if dict(addr=addr, netmask=netmask) in interface_addr_list:
Łukasz Nowak's avatar
Łukasz Nowak committed
799 800 801 802
        # confirmed to be configured
        return dict(addr=addr, netmask=netmask)
      if netmask == address_dict['netmask']:
        # same netmask, so there is a chance to add good one
803
        interface_network = netaddr.ip.IPNetwork('%s/%s' % (address_dict['addr'],
Łukasz Nowak's avatar
Łukasz Nowak committed
804
          netmaskToPrefixIPv6(address_dict['netmask'])))
Vincent Pelletier's avatar
Vincent Pelletier committed
805 806
        requested_network = netaddr.ip.IPNetwork('%s/%s' % (addr,
          netmaskToPrefixIPv6(netmask)))
807
        if interface_network.network == requested_network.network:
Łukasz Nowak's avatar
Łukasz Nowak committed
808 809 810 811 812 813 814 815 816
          # same network, try to add
          if self._addSystemAddress(addr, netmask):
            # succeed, return it
            return dict(addr=addr, netmask=netmask)

    # Try 10 times to add address, raise in case if not possible
    try_num = 10
    netmask = address_dict['netmask']
    while try_num > 0:
Vincent Pelletier's avatar
Vincent Pelletier committed
817 818
      addr = ':'.join(address_dict['addr'].split(':')[:-1] + ['%x' % (
        random.randint(1, 65000), )])
Łukasz Nowak's avatar
Łukasz Nowak committed
819
      socket.inet_pton(socket.AF_INET6, addr)
Vincent Pelletier's avatar
Vincent Pelletier committed
820 821
      if dict(addr=addr, netmask=netmask) not in \
          self.getGlobalScopeAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
        # Checking the validity of the IPv6 address
        if self._addSystemAddress(addr, netmask):
          return dict(addr=addr, netmask=netmask)
        try_num -= 1

    raise AddressGenerationError(addr)

class Parser(OptionParser):
  """
  Parse all arguments.
  """
  def __init__(self, usage=None, version=None):
    """
    Initialize all options possibles.
    """
    OptionParser.__init__(self, usage=usage, version=version,
                          option_list=[
      Option("-x", "--computer_xml",
             help="Path to file with computer's XML. If does not exists, "
                  "will be created",
             default=None,
             type=str),
      Option("-l", "--log_file",
             help="The path to the log file used by the script.",
             type=str),
      Option("-i", "--input_definition_file",
             help="Path to file to read definition of computer instead of "
             "declaration. Using definition file allows to disable "
             "'discovery' of machine services and allows to define computer "
             "configuration in fully controlled manner.",
             type=str),
      Option("-o", "--output_definition_file",
             help="Path to file to write definition of computer from "
             "declaration.",
             type=str),
      Option("-n", "--dry_run",
858 859 860
             help="Don't actually do anything.",
             default=False,
             action="store_true"),
Łukasz Nowak's avatar
Łukasz Nowak committed
861 862 863 864 865 866 867 868 869 870 871 872
      Option("-v", "--verbose",
             default=False,
             action="store_true",
             help="Verbose output."),
      Option("-c", "--console",
             default=False,
             action="store_true",
             help="Console output."),
      Option('--alter_user', choices=['True', 'False'],
        help="Shall slapformat alter user database [default: True]"),
      Option('--alter_network', choices=['True', 'False'],
        help="Shall slapformat alter network configuration [default: True]"),
873
      Option('--now',
874 875 876
             help="Launch slapformat without delay",
             default=False,
             action="store_true"),
Łukasz Nowak's avatar
Łukasz Nowak committed
877 878
      ])

879
  def check_args(self, args):
Łukasz Nowak's avatar
Łukasz Nowak committed
880 881 882
    """
    Check arguments
    """
883 884 885 886
    if args:
      (options, args) = self.parse_args(list(args))
    else:
      (options, args) = self.parse_args()
Łukasz Nowak's avatar
Łukasz Nowak committed
887 888 889 890 891
    if len(args) != 1:
      self.error("Incorrect number of arguments")
    return options, args[0]

def run(config):
892 893 894 895
  # Define the computer
  if config.input_definition_file:
    filepath = os.path.abspath(config.input_definition_file)
    config.logger.info('Using definition file %r' % filepath)
896 897 898
    computer_definition = ConfigParser.RawConfigParser({
      'software_user': 'slapsoft',
    })
899
    computer_definition.read(filepath)
900
    interface = None
901 902 903
    address = None
    netmask = None
    if computer_definition.has_option('computer', 'address'):
Vincent Pelletier's avatar
Vincent Pelletier committed
904 905
      address, netmask = computer_definition.get('computer',
        'address').split('/')
906
    if config.alter_network and config.interface_name is not None \
907
        and config.ipv4_local_network is not None:
908
      interface = Interface(config.interface_name, config.ipv4_local_network,
909 910 911
        config.ipv6_interface)
    computer = Computer(
        reference=config.computer_id,
912
        interface=interface,
913 914
        addr=address,
        netmask=netmask,
915 916
        ipv6_interface=config.ipv6_interface,
        software_user=computer_definition.get('computer', 'software_user'),
917 918 919 920 921 922 923 924 925 926
      )
    partition_list = []
    for partition_number in range(int(config.partition_amount)):
      section = 'partition_%s' % partition_number
      user = User(computer_definition.get(section, 'user'))
      address_list = []
      for a in computer_definition.get(section, 'address').split():
        address, netmask = a.split('/')
        address_list.append(dict(addr=address, netmask=netmask))
      tap = Tap(computer_definition.get(section, 'network_interface'))
Vincent Pelletier's avatar
Vincent Pelletier committed
927 928 929 930
      partition_list.append(Partition(reference=computer_definition.get(
        section, 'pathname'),
          path=os.path.join(config.instance_root, computer_definition.get(
            section, 'pathname')),
931 932 933 934 935 936 937 938
          user=user,
          address_list=address_list,
          tap=tap,
          ))
    computer.partition_list = partition_list
  else:
    # no definition file, figure out computer
    if os.path.exists(config.computer_xml):
Vincent Pelletier's avatar
Vincent Pelletier committed
939 940 941 942
      config.logger.info('Loading previous computer data from %r' % (
        config.computer_xml, ))
      computer = Computer.load(config.computer_xml,
        reference=config.computer_id, ipv6_interface=config.ipv6_interface)
943 944
      # Connect to the interface defined by the configuration
      computer.interface = Interface(config.interface_name, config.ipv4_local_network,
945
          config.ipv6_interface)
Łukasz Nowak's avatar
Łukasz Nowak committed
946
    else:
947
      # If no pre-existent configuration found, creating a new computer object
Vincent Pelletier's avatar
Vincent Pelletier committed
948 949
      config.logger.warning('Creating new data computer with id %r' % (
        config.computer_id, ))
950 951
      computer = Computer(
        reference=config.computer_id,
952
        interface=Interface(config.interface_name, config.ipv4_local_network,
953 954 955
          config.ipv6_interface),
        addr=None,
        netmask=None,
956 957
        ipv6_interface=config.ipv6_interface,
        software_user=config.software_user,
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
      )

    partition_amount = int(config.partition_amount)
    existing_partition_amount = len(computer.partition_list)
    if existing_partition_amount > partition_amount:
      raise ValueError('Requested amount of computer partitions (%s) is lower '
          'then already configured (%s), cannot continue' % (partition_amount,
            len(computer.partition_list)))

    config.logger.info('Adding %s new partitions' %
        (partition_amount-existing_partition_amount))
    for nb_iter in range(existing_partition_amount, partition_amount):
      # add new ones
      user = User("%s%s" % (config.user_base_name, nb_iter))

      tap = Tap("%s%s" % (config.tap_base_name, nb_iter))

      path = os.path.join(config.instance_root, "%s%s" % (
                           config.partition_base_name, nb_iter))
      computer.partition_list.append(
        Partition(
          reference="%s%s" % (config.partition_base_name, nb_iter),
          path=path,
          user=user,
          address_list=None,
          tap=tap,
          ))

  computer.instance_root = config.instance_root
  computer.software_root = config.software_root
  config.logger.info('Updating computer')
989
  address = computer.getAddress(config.create_tap)
990 991 992 993 994 995 996
  computer.address = address['addr']
  computer.netmask = address['netmask']

  if config.output_definition_file:
    computer_definition = ConfigParser.RawConfigParser()
    computer_definition.add_section('computer')
    if computer.address is not None and computer.netmask is not None:
Vincent Pelletier's avatar
Vincent Pelletier committed
997 998
      computer_definition.set('computer', 'address', '/'.join(
        [computer.address, computer.netmask]))
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
    partition_number = 0
    for partition in computer.partition_list:
      section = 'partition_%s' % partition_number
      computer_definition.add_section(section)
      address_list = []
      for address in partition.address_list:
        address_list.append('/'.join([address['addr'], address['netmask']]))
      computer_definition.set(section, 'address', ' '.join(address_list))
      computer_definition.set(section, 'user', partition.user.name)
      computer_definition.set(section, 'user', partition.user.name)
      computer_definition.set(section, 'network_interface', partition.tap.name)
      computer_definition.set(section, 'pathname', partition.reference)
      partition_number += 1
    filepath = os.path.abspath(config.output_definition_file)
    computer_definition.write(open(filepath, 'w'))
    config.logger.info('Stored computer definition in %r' % filepath)
  computer.construct(alter_user=config.alter_user,
1016
      alter_network=config.alter_network, create_tap=config.create_tap)
1017 1018 1019 1020 1021 1022

  # Dumping and sending to the erp5 the current configuration
  if not config.dry_run:
    computer.dump(config.computer_xml)
  config.logger.info('Posting information to %r' % config.master_url)
  computer.send(config)
1023
  config.logger.info('slapformat successfully prepared computer.')
Łukasz Nowak's avatar
Łukasz Nowak committed
1024

1025
class Config(object):
1026 1027 1028 1029
  key_file = None
  cert_file = None
  alter_network = None
  alter_user = None
1030
  create_tap = None
1031 1032 1033 1034 1035 1036
  computer_xml = None
  logger = None
  log_file = None
  verbose = None
  dry_run = None
  console = None
1037
  software_user = None
1038 1039 1040

  @staticmethod
  def checkRequiredBinary(binary_list):
Łukasz Nowak's avatar
Łukasz Nowak committed
1041 1042
    missing_binary_list = []
    for b in binary_list:
1043 1044
      if type(b) != type([]):
        b = [b]
Łukasz Nowak's avatar
Łukasz Nowak committed
1045
      try:
1046
        callAndRead(b)
Łukasz Nowak's avatar
Łukasz Nowak committed
1047 1048 1049 1050 1051
      except ValueError:
        pass
      except OSError:
        missing_binary_list.append(b)
    if missing_binary_list:
Vincent Pelletier's avatar
Vincent Pelletier committed
1052 1053
      raise UsageError('Some required binaries are missing or not '
          'functional: %s' % (','.join(missing_binary_list), ))
Łukasz Nowak's avatar
Łukasz Nowak committed
1054 1055 1056 1057 1058 1059 1060

  def setConfig(self, option_dict, configuration_file_path):
    """
    Set options given by parameters.
    """
    self.key_file = None
    self.cert_file = None
1061 1062 1063 1064 1065

    # set up logging
    self.logger = logging.getLogger("slapformat")
    self.logger.setLevel(logging.INFO)

Łukasz Nowak's avatar
Łukasz Nowak committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
    # Set options parameters
    for option, value in option_dict.__dict__.items():
      setattr(self, option, value)

    # Load configuration file
    configuration_parser = ConfigParser.SafeConfigParser()
    configuration_parser.read(configuration_file_path)
    # Merges the arguments and configuration
    for section in ("slapformat", "slapos"):
      configuration_dict = dict(configuration_parser.items(section))
      for key in configuration_dict:
        if not getattr(self, key, None):
          setattr(self, key, configuration_dict[key])

    # setup some nones
1081
    for parameter in ['interface_name', 'partition_base_name', 'user_base_name',
1082
        'tap_base_name', 'ipv4_local_network', 'ipv6_interface']:
Łukasz Nowak's avatar
Łukasz Nowak committed
1083 1084
      if getattr(self, parameter, None) is None:
        setattr(self, parameter, None)
1085

1086 1087 1088 1089
    # Backward compatibility
    if not getattr(self, "interface_name", None) \
        and getattr(self, "bridge_name", None):
      setattr(self, "interface_name", self.bridge_name)
1090 1091
      self.logger.warning('bridge_name option is deprecated and should be '
          'replaced by interface_name.')
1092 1093 1094
    if not getattr(self, "create_tap", None) \
        and getattr(self, "no_bridge", None):
      setattr(self, "create_tap", not self.no_bridge)
1095 1096
      self.logger.warning('no_bridge option is deprecated and should be '
          'replaced by create_tap.')
Łukasz Nowak's avatar
Łukasz Nowak committed
1097 1098 1099 1100 1101 1102

    # Set defaults lately
    if self.alter_network is None:
      self.alter_network = 'True'
    if self.alter_user is None:
      self.alter_user = 'True'
1103 1104
    if self.software_user is None:
      self.software_user = 'slapsoft'
1105 1106
    if self.create_tap is None:
      self.create_tap = True
Łukasz Nowak's avatar
Łukasz Nowak committed
1107

1108
    # Configure logging
Łukasz Nowak's avatar
Łukasz Nowak committed
1109 1110 1111 1112
    if self.console:
      self.logger.addHandler(logging.StreamHandler())

    # Convert strings to booleans
1113
    for o in ['alter_network', 'alter_user', 'create_tap']:
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
      attr = getattr(self, o)
      if isinstance(attr, str):
        if attr.lower() == 'true':
          root_needed = True
          setattr(self, o, True)
        elif attr.lower() == 'false':
          setattr(self, o, False)
        else:
          message = 'Option %r needs to be "True" or "False", wrong value: ' \
              '%r' % (o, getattr(self, o))
          self.logger.error(message)
          raise UsageError(message)
Łukasz Nowak's avatar
Łukasz Nowak committed
1126

1127 1128 1129
    if not self.dry_run:
      if self.alter_user:
        self.checkRequiredBinary(['groupadd', 'useradd', 'usermod'])
1130
      if self.create_tap:
1131
        self.checkRequiredBinary([['tunctl', '-d']])
1132
      if self.alter_network:
1133
        self.checkRequiredBinary(['ip'])
1134
    # Required, even for dry run
1135
    if self.alter_network and self.create_tap:
1136
      self.checkRequiredBinary(['brctl'])
Łukasz Nowak's avatar
Łukasz Nowak committed
1137

1138 1139 1140 1141
    # Check if root is needed
    if (self.alter_network or self.alter_user) and not self.dry_run:
      root_needed = True
    else:
1142
      root_needed = False
1143

Łukasz Nowak's avatar
Łukasz Nowak committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
    # check root
    if root_needed and os.getuid() != 0:
      message = "Root rights are needed"
      self.logger.error(message)
      raise UsageError(message)

    if self.log_file:
      if not os.path.isdir(os.path.dirname(self.log_file)):
        # fallback to console only if directory for logs does not exists and
        # continue to run
        raise ValueError('Please create directory %r to store %r log file' % (
          os.path.dirname(self.log_file), self.log_file))
      else:
        file_handler = logging.FileHandler(self.log_file)
Vincent Pelletier's avatar
Vincent Pelletier committed
1158 1159
        file_handler.setFormatter(logging.Formatter("%(asctime)s - "
          "%(name)s - %(levelname)s - %(message)s"))
Łukasz Nowak's avatar
Łukasz Nowak committed
1160 1161
        self.logger.addHandler(file_handler)
        self.logger.info('Configured logging to file %r' % self.log_file)
1162

Łukasz Nowak's avatar
Łukasz Nowak committed
1163 1164 1165 1166 1167 1168
    # Check mandatory options
    for parameter in ('computer_id', 'instance_root', 'master_url',
                      'software_root', 'computer_xml'):
      if not getattr(self, parameter, None):
        raise UsageError("Parameter '%s' is not defined." % parameter)

1169 1170 1171 1172 1173 1174 1175 1176 1177
    # Check existence of SSL certificate files, if defined
    for attribute in ['key_file', 'cert_file', 'master_ca_file']:
      file_location = getattr(self, attribute, None)
      if file_location is not None:
        if not os.path.exists(file_location):
          self.logger.fatal('File %r does not exist or is no readable.' %
              file_location)
          sys.exit(1)

Łukasz Nowak's avatar
Łukasz Nowak committed
1178 1179 1180 1181
    self.logger.info("Started.")
    if self.verbose:
      self.logger.setLevel(logging.DEBUG)
      self.logger.debug("Verbose mode enabled.")
1182 1183
    if self.dry_run:
      self.logger.info("Dry-run mode enabled.")
1184
    if self.create_tap:
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
1185
      self.logger.info("Tap creation mode enabled.")
Łukasz Nowak's avatar
Łukasz Nowak committed
1186 1187 1188 1189 1190

    # Calculate path once
    self.computer_xml = os.path.abspath(self.computer_xml)


1191
def main(*args):
Łukasz Nowak's avatar
Łukasz Nowak committed
1192
  "Run default configuration."
Vincent Pelletier's avatar
Vincent Pelletier committed
1193 1194 1195
  global os
  global callAndRead
  real_callAndRead = callAndRead
Łukasz Nowak's avatar
Łukasz Nowak committed
1196 1197
  usage = "usage: %s [options] CONFIGURATION_FILE" % sys.argv[0]

1198 1199 1200
  # Parse arguments
  options, configuration_file_path = Parser(usage=usage).check_args(args)
  config = Config()
Łukasz Nowak's avatar
Łukasz Nowak committed
1201 1202 1203
  try:
    config.setConfig(options, configuration_file_path)
  except UsageError, err:
1204
    print >>sys.stderr, err.message
Łukasz Nowak's avatar
Łukasz Nowak committed
1205
    print >>sys.stderr, "For help use --help"
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
    sys.exit(1)
  os = OS(config)
  if config.dry_run:
    def dry_callAndRead(argument_list, raise_on_error=True):
      if argument_list == ['brctl', 'show']:
        return real_callAndRead(argument_list, raise_on_error)
      else:
        return 0, ''
    callAndRead = dry_callAndRead
    def fake_getpwnam(user):
1216
      class result(object):
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
        pw_uid = 12345
        pw_gid = 54321
      return result
    pwd.getpwnam = fake_getpwnam
  else:
    dry_callAndRead = real_callAndRead
  if config.verbose:
    def logging_callAndRead(argument_list, raise_on_error=True):
      config.logger.debug(' '.join(argument_list))
      return dry_callAndRead(argument_list, raise_on_error)
    callAndRead = logging_callAndRead
1228 1229 1230 1231 1232 1233
  # Add delay between 0 and 1 hour
  if not config.now:
    duration = float(60*60) * random.random()
    print("Sleeping for %s seconds. To disable this feature, " \
                    "use with --now parameter in manual." % duration)
    time.sleep(duration)
1234 1235 1236 1237 1238
  try:
    run(config)
  except:
    config.logger.exception('Uncaught exception:')
    raise