utils.py 10.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
##############################################################################
#
# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
#
# 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 adviced 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.
#
##############################################################################

import unittest
import os
import socket
from contextlib import closing
import logging
33
import StringIO
34 35
import xmlrpclib

36
import supervisor.xmlrpc
37 38 39 40
from erp5.util.testnode.SlapOSControler import SlapOSControler
from erp5.util.testnode.ProcessManager import ProcessManager


41
# Utility functions
42 43 44 45 46 47 48 49 50
def findFreeTCPPort(ip=''):
  """Find a free TCP port to listen to.
  """
  family = socket.AF_INET6 if ':' in ip else socket.AF_INET
  with closing(socket.socket(family, socket.SOCK_STREAM)) as s:
    s.bind((ip, 0))
    return s.getsockname()[1]


51 52 53
# TODO:
#  - allow requesting multiple instances ?

54
class SlapOSInstanceTestCase(unittest.TestCase):
55 56
  """Install one slapos instance.

57 58
  This test case install software(s) and request one instance during
  `setUpClass` and destroy the instance during `tearDownClass`.
59

60 61
  Software Release URL, Instance Software Type and Instance Parameters can be
  defined on the class.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

  All tests from the test class will run with the same instance.

  The following class attributes are available:

    * `computer_partition`:  the computer partition instance, implementing
    `slapos.slap.interface.slap.IComputerPartition`.

    * `computer_partition_root_path`: the path of the instance root directory.

  """

  # Methods to be defined by subclasses.
  @classmethod
  def getSoftwareURLList(cls):
    """Return URL of software releases to install.

    To be defined by subclasses.
    """
    raise NotImplementedError()

  @classmethod
  def getInstanceParameterDict(cls):
    """Return instance parameters

    To be defined by subclasses if they need to request instance with specific
    parameters.
    """
    return {}

  @classmethod
  def getInstanceSoftwareType(cls):
    """Return software type for instance, default "default"

    To be defined by subclasses if they need to request instance with specific
    software type.
    """
    return "default"

  # Utility methods.
102 103 104 105 106 107 108 109 110 111 112 113
  def getSupervisorRPCServer(self):
    """Returns a XML-RPC connection to the supervisor used by slapos node

    Refer to http://supervisord.org/api.html for details of available methods.
    """
    # xmlrpc over unix socket https://stackoverflow.com/a/11746051/7294664
    return xmlrpclib.ServerProxy(
       'http://slapos-supervisor',
       transport=supervisor.xmlrpc.SupervisorTransport(
           None,
           None,
           # XXX hardcoded socket path
114 115
           serverurl="unix://{working_directory}/inst/supervisord.socket".format(
             **self.config)))
116

117
  # Unittest methods
118
  @classmethod
119 120
  def setUpClass(cls):
    """Setup the class, build software and request an instance.
121

122 123
    If you have to override this method, do not forget to call this method on
    parent class.
124
    """
125 126 127 128
    try:
      cls.setUpWorkingDirectory()
      cls.setUpConfig()
      cls.setUpSlapOSController()
129

130 131 132 133
      cls.runSoftwareRelease()
      # XXX instead of "runSoftwareRelease", it would be better to be closer to slapos usage:
      # cls.supplySoftwares()
      # cls.installSoftwares()
134

135 136 137 138 139 140 141 142 143 144 145 146 147
      cls.runComputerPartition()
      # XXX instead of "runComputerPartition", it would be better to be closer to slapos usage:
      # cls.requestInstances()
      # cls.createInstances()
      # cls.requestInstances()

    except Exception:
      cls.stopSlapOSProcesses()
      raise

  @classmethod
  def tearDownClass(cls):
    """Tear down class, stop the processes and destroy instance.
148
    """
149
    cls.stopSlapOSProcesses()
150

151 152 153 154 155
  # Implementation
  @classmethod
  def stopSlapOSProcesses(cls):
    if hasattr(cls, '_process_manager'):
      cls._process_manager.killPreviousRun()
156 157 158

  @classmethod
  def setUpWorkingDirectory(cls):
159
    """Initialise the directories"""
160 161 162 163 164 165 166
    cls.working_directory = os.environ.get(
        'SLAPOS_TEST_WORKING_DIR',
        os.path.join(os.path.dirname(__file__), '.slapos'))
    # To prevent error: Cannot open an HTTP server: socket.error reported
    # AF_UNIX path too long This `working_directory` should not be too deep.
    # Socket path is 108 char max on linux
    # https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238
167 168
    # Supervisord socket name contains the pid number, which is why we add
    # .xxxxxxx in this check.
169
    if len(cls.working_directory + '/inst/supervisord.socket.xxxxxxx') > 108:
170 171
      raise RuntimeError('working directory ( {} ) is too deep, try setting '
              'SLAPOS_TEST_WORKING_DIR'.format(cls.working_directory))
172 173 174 175 176 177

    if not os.path.exists(cls.working_directory):
      os.mkdir(cls.working_directory)

  @classmethod
  def setUpConfig(cls):
178
    """Create slapos configuration"""
179 180 181 182 183 184 185 186 187 188
    cls.config = {
      "working_directory": cls.working_directory,
      "slapos_directory": cls.working_directory,
      "log_directory": cls.working_directory,
      "computer_id": 'slapos.test',  # XXX
      'proxy_database': os.path.join(cls.working_directory, 'proxy.db'),
      'partition_reference': cls.__name__,
      # "proper" slapos command must be in $PATH
      'slapos_binary': 'slapos',
    }
189
    # Some tests are expecting that local IP is not set to 127.0.0.1
190 191
    ipv4_address = os.environ.get('SLAPOS_TEST_IPV4', '127.0.1.1')
    ipv6_address = os.environ['SLAPOS_TEST_IPV6']
192 193 194 195 196 197 198 199 200

    cls.config['proxy_host'] = cls.config['ipv4_address'] = ipv4_address
    cls.config['ipv6_address'] = ipv6_address
    cls.config['proxy_port'] = findFreeTCPPort(ipv4_address)
    cls.config['master_url'] = 'http://{proxy_host}:{proxy_port}'.format(
      **cls.config)

  @classmethod
  def setUpSlapOSController(cls):
201 202 203 204 205 206 207 208 209
    """Create the a "slapos controller" and supply softwares from `getSoftwareURLList`.

    This is equivalent to:

    slapos proxy start
    for sr in getSoftwareURLList; do
      slapos supply $SR $COMP
    done
    """
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
    cls._process_manager = ProcessManager()

    # XXX this code is copied from testnode code
    cls.slapos_controler = SlapOSControler(
        cls.working_directory,
        cls.config
    )

    slapproxy_log = os.path.join(cls.config['log_directory'], 'slapproxy.log')
    logger = logging.getLogger(__name__)
    logger.debug('Configured slapproxy log to %r', slapproxy_log)

    cls.software_url_list = cls.getSoftwareURLList()
    cls.slapos_controler.initializeSlapOSControler(
        slapproxy_log=slapproxy_log,
        process_manager=cls._process_manager,
        reset_software=False,
        software_path_list=cls.software_url_list)

229 230 231 232
    # XXX we should check *earlier* if that pidfile exist and if supervisord
    # process still running, because if developer started supervisord (or bugs?)
    # then another supervisord will start and starting services a second time
    # will fail.
233 234 235 236 237
    cls._process_manager.supervisord_pid_file = os.path.join(
      cls.slapos_controler.instance_root, 'var', 'run', 'supervisord.pid')

  @classmethod
  def runSoftwareRelease(cls):
238
    """Run all the software releases that were supplied before.
239

240 241 242 243
    This is the equivalent of `slapos node software`.

    The tests will be marked file if software building fail.
    """
244 245 246 247 248 249 250 251 252 253 254
    logger = logging.getLogger()
    logger.level = logging.DEBUG
    stream = StringIO.StringIO()
    stream_handler = logging.StreamHandler(stream)
    logger.addHandler(stream_handler)

    try:
      cls.software_status_dict = cls.slapos_controler.runSoftwareRelease(
        cls.config, environment=os.environ)
      stream.seek(0)
      stream.flush()
255 256
      message = ''.join(stream.readlines()[-100:])
      assert cls.software_status_dict['status_code'] == 0, message
257 258 259
    finally:
      logger.removeHandler(stream_handler)
      del stream
260

261

262
  @classmethod
263
  def runComputerPartition(cls, max_quantity=None):
264 265 266 267 268 269 270 271 272 273 274
    """Instanciate the software.

    This is the equivalent of doing:

    slapos request --type=getInstanceSoftwareType --parameters=getInstanceParameterDict
    slapos node instance

    and return the slapos request instance parameters.

    This can be called by tests to simulate re-request with different parameters.
    """
275 276 277
    run_cp_kw = {}
    if max_quantity is not None:
      run_cp_kw['max_quantity'] = max_quantity
278 279 280 281 282 283
    logger = logging.getLogger()
    logger.level = logging.DEBUG
    stream = StringIO.StringIO()
    stream_handler = logging.StreamHandler(stream)
    logger.addHandler(stream_handler)

284 285 286
    if cls.getInstanceSoftwareType() != 'default':
      raise NotImplementedError

287
    instance_parameter_dict = cls.getInstanceParameterDict()
288 289
    try:
      cls.instance_status_dict = cls.slapos_controler.runComputerPartition(
290 291
        cls.config,
        cluster_configuration=instance_parameter_dict,
292 293
        environment=os.environ,
        **run_cp_kw)
294 295
      stream.seek(0)
      stream.flush()
296 297
      message = ''.join(stream.readlines()[-100:])
      assert cls.instance_status_dict['status_code'] == 0, message
298 299 300
    finally:
      logger.removeHandler(stream_handler)
      del stream
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

    # FIXME: similar to test node, only one (root) partition is really
    #        supported for now.
    computer_partition_list = []
    for i in range(len(cls.software_url_list)):
      computer_partition_list.append(
          cls.slapos_controler.slap.registerOpenOrder().request(
            cls.software_url_list[i],
            # This is how testnode's SlapOSControler name created partitions
            partition_reference='testing partition {i}'.format(
              i=i, **cls.config),
            partition_parameter_kw=instance_parameter_dict))

    # expose some class attributes so that tests can use them:
    # the ComputerPartition instances, to getInstanceParameterDict
    cls.computer_partition = computer_partition_list[0]

    # the path of the instance on the filesystem, for low level inspection
    cls.computer_partition_root_path = os.path.join(
320 321
        cls.config['working_directory'],
        'inst',
322 323 324 325
        cls.computer_partition.getId())