test.py 21.6 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
##############################################################################
#
# 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 os
29
import unittest
30 31 32 33
import paramiko
import contextlib
import base64
import hashlib
34
import subprocess
35 36
import json
import time
37

38 39
from six.moves.urllib.parse import urlparse
from six.moves.urllib.parse import quote
40
from six.moves.urllib.parse import urljoin
41
from six.moves.configparser import ConfigParser
42
import requests
43
import six
44

45
from slapos.recipe.librecipe import generateHashFromFiles
46
from slapos.testing.testcase import makeModuleSetUpAndTestCaseClass
47
from slapos.util import bytes2str
48

49 50
skipIfPython3 = unittest.skipIf(six.PY3, 'rdiff-backup is not compatible with Python 3 yet')

51 52
setUpModule, SlapOSInstanceTestCase = makeModuleSetUpAndTestCaseClass(
    os.path.abspath(
53 54
        os.path.join(os.path.dirname(__file__), '..',
                     'software%s.cfg' % ("-py3" if six.PY3 else ""))))
55

56 57 58 59 60 61 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 102 103 104 105 106 107 108 109 110 111 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 147 148 149 150 151 152 153 154 155 156 157 158 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 191 192 193 194 195 196 197 198 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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
class SlaprunnerTestCase(SlapOSInstanceTestCase):
  # Slaprunner uses unix sockets, so it needs short paths.
  __partition_reference__ = 's'

  def _openSoftwareRelease(self, software_release="erp5testnode/testsuite/dummy"):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/setCurrentProject" % parameter_dict['url']

    data = {
      "path": "workspace/slapos/software/%s" % software_release,
    }
    resp = self._postToSlaprunner(url, data) 
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertNotEqual(json.loads(resp.text)['code'], 0,
       'Unexpecting result in call to setCurrentProject: %s' % resp.text)

  def _buildSoftwareRelease(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/runSoftwareProfile" % parameter_dict['url']
    resp = self._postToSlaprunner(url, {}) 
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertEqual(json.loads(resp.text)['result'], True,
       'Unexpecting result in call to runSoftwareProfile: %s' % resp.text)

  def _deployInstance(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/runInstanceProfile" % parameter_dict['url']
    resp = self._postToSlaprunner(url, {}) 
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertEqual(json.loads(resp.text)['result'], True,
       'Unexpecting result in call to runSoftwareProfile: %s' % resp.text)

  def _gitClone(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/cloneRepository" % parameter_dict['url']

    data = {
      "repo": "https://lab.nexedi.com/nexedi/slapos.git",
      "name": "workspace/slapos",
      "email": "slapos@slapos.org",
      "user": "slapos"
    }
    resp = self._postToSlaprunner(url, data)
    d = json.loads(resp.text)
    if d['code'] == 0:
      return "OK"

  def _isSoftwareReleaseReady(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/isSRReady" % parameter_dict['url']
    resp = self._getFromSlaprunner(url) 
    if requests.codes.ok != resp.status_code:
      return -1
    return resp.text

  def _waitForSoftwareBuild(self, limit=5000):
    status = self._isSoftwareReleaseReady()
    while limit > 0 and status != "1":
      status = self._isSoftwareReleaseReady()
      limit -= 1
      if status == '0':
        self.logger.debug("Software release is Failing to Build. Sleeping...")
      else:
        self.logger.debug('Software is still building. Sleeping...')
      time.sleep(20)

  def _waitForInstanceDeploy(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/slapgridResult" % parameter_dict['url']
    data = {
      "position": 0,
      "log": ""
      }
    while True:
      time.sleep(25)
      resp = self._postToSlaprunner(url, data) 
      if requests.codes.ok != resp.status_code:
        continue
      if json.loads(resp.text)["instance"]["state"] is False:
        break
      self.logger.info('Buildout is still running. Sleeping....')
    self.logger.info("Instance has been deployed.")

  def _getFromSlaprunner(self, url):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    return requests.get(
        url,
        verify=False,
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))

  def _postToSlaprunner(self, url, data):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    return requests.post(
        url,
        verify=False,
        data=data,
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))

  def _getFileContent(self, relative_path):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = "%s/getFileContent" % parameter_dict['url']

    data = {
      "file": relative_path 
    }
    resp = self._postToSlaprunner(url, data) 
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertNotEqual(json.loads(resp.text)['code'], 0,
       'Unexpecting result in call to getFileContent: %s' % resp.text)

    return json.loads(resp.text)["result"]

  def _waitForCloneToBeReadyForTakeover(self, scope="runner-1", limit=500):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    takeover_url = parameter_dict["takeover-%s-url" % scope]

    def getTakeoverPageContent():
      resp = requests.get(takeover_url, verify=True)
      self.assertEqual(requests.codes.ok, resp.status_code)
      return resp.text
    takeover_page_content = getTakeoverPageContent()
    while "<b>Last valid backup:</b> No backup downloaded yet, takeover should not happen now." in takeover_page_content:
      time.sleep(10)
      if limit < 0:
        raise Exception("Timeout: No valid Backup")
      takeover_page_content = getTakeoverPageContent()
      limit -= 1

    while "<b>Importer script(s) of backup in progress:</b> True" in takeover_page_content:
      time.sleep(10)
      if limit < 0:
        raise Exception("Timeout: Backup still in progress")
      takeover_page_content = getTakeoverPageContent()
      limit -= 1

  def _doTakeover(self, scope="runner-1"):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    takeover_url = parameter_dict["takeover-%s-url" % scope]
    takeover_password = parameter_dict["takeover-%s-password" % scope]
    
    resp = requests.get(
      "%s?password=%s" % (takeover_url, takeover_password),
      verify=True)
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertNotIn("Error", resp.text,
            "An Error occured: %s" % resp.text)
    self.assertIn("Success", resp.text,
            "An Success not in %s" % resp.text)
    return resp.text

class TestWebRunnerBasicUsage(SlaprunnerTestCase):

  @classmethod
  def getInstanceParameterDict(cls):
    return {
        'auto-deploy': 'true',
        'software-root': os.path.join(cls.slap._instance_root, "..", "soft"),
        'buildout-shared-folder': os.path.join(cls.slap._instance_root, "..", "shared"),
        "slapos-reference": 'slaprunner-basic-test-resiliency'
       }

  def test_open_software_release(self):
    self._openSoftwareRelease()

  def test_git_clone(self):
    self._gitClone()

  @unittest.skip('Skip as _getFileContent dont work for now')
  def test_basic_usage(self):
    self._openSoftwareRelease()
    self._buildSoftwareRelease()
    self._waitForSoftwareBuild()
    self._deployInstance()
    self._waitForInstanceDeploy()

    result = self._getFileContent(
      "instance_root/slappart0/var/log/log.log")

    self.assertTrue(result.startswith("Hello"),
      result)

class TestWebRunnerAutorun(SlaprunnerTestCase):

  @classmethod
  def getInstanceParameterDict(cls):
    return {
        # Auto deploy is required for the isSRReady works. 
        'auto-deploy': 'true',
        'autorun': 'true',
        'software-root': os.path.join(cls.slap._instance_root, "..", "soft"),
        'buildout-shared-folder': os.path.join(cls.slap._instance_root, "..", "shared"),
        'slapos-software': 'software/erp5testnode/testsuite/dummy',
        # XXX HACK!
        "slapos-reference": 'slaprunner-basic-test-resiliency'
       }

  @unittest.skip('Skip as _getFileContent dont work for now')
  def test_basic_usage(self):
    self._openSoftwareRelease()
    self._waitForSoftwareBuild()
    self._waitForSoftwareBuild()
    self._waitForInstanceDeploy()
    self._waitForInstanceDeploy()

    result = self._getFileContent(
      "instance_root/slappart0/var/log/log.log")

    self.assertTrue(result.startswith("Hello"), result)
264

265 266 267 268 269 270 271 272 273 274 275 276 277 278
class TestWeb(SlaprunnerTestCase):
  def test_slaprunner(self):
    # slaprunner main interface is password protected
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = parameter_dict['url']
    resp = requests.get(url, verify=False)
    self.assertEqual(requests.codes.unauthorized, resp.status_code)
    resp = requests.get(
        url,
        verify=False,
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertIn('SlapOS', resp.text)

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
  def test_slaprunner_redirects(self):
    # redirects also work as expected. In this test we visit stopAllPartition
    # which should redirect to inspectInstance
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = parameter_dict['url']
    resp = requests.get(
        urljoin(url, '/stopAllPartition'),
        verify=False,
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))
    self.assertEqual(resp.status_code, requests.codes.ok)
    self.assertEqual(resp.url, urljoin(url, '/inspectInstance'))

    # this also works behind a frontend
    resp = requests.get(
        urljoin(url, '/stopAllPartition'),
        verify=False,
        allow_redirects=False,
        headers={'Host': 'example.com:1234'},
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))
    self.assertEqual(resp.status_code, requests.codes.found)
    self.assertEqual(resp.headers['Location'], 'https://example.com:1234/inspectInstance')

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
  def test_shellinabox(self):
    # shellinabox exists at /shellinabox and is password protected
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    url = urljoin(parameter_dict['url'], '/shellinabox')
    resp = requests.get(url, verify=False)
    self.assertEqual(requests.codes.unauthorized, resp.status_code)
    resp = requests.get(
        url,
        verify=False,
        auth=(parameter_dict['init-user'], parameter_dict['init-password']))
    self.assertEqual(requests.codes.ok, resp.status_code)
    self.assertIn('ShellInABox', resp.text)
    self.assertNotIn('SlapOS', resp.text)

  def test_public_url(self):
    # ~/srv/runner/public/ is served over http
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    public_url = parameter_dict['public-url']

    hello_file = os.path.join(
        self.computer_partition_root_path,
        'srv',
        'runner',
        'public',
        'hello.html')
    self.addCleanup(os.remove, hello_file)
    with open(hello_file, 'w') as f:
      f.write('<b>Hello</b>')

    index = requests.get(public_url, verify=False)
    self.assertEqual(requests.codes.ok, index.status_code)
    self.assertIn('hello.html', index.text)

    hello = requests.get(urljoin(public_url, 'hello.html'), verify=False)
    self.assertEqual(requests.codes.ok, hello.status_code)
    self.assertIn('<b>Hello</b>', hello.text)


339 340 341
class TestSSH(SlaprunnerTestCase):
  @classmethod
  def getInstanceParameterDict(cls):
342
    cls.ssh_key_list = [paramiko.RSAKey.generate(1024) for i in range(2)]
343
    return {
344 345 346
        'user-authorized-key': 'ssh-rsa {}\nssh-rsa {}'.format(
          *[key.get_base64() for key in cls.ssh_key_list]
          )
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
    }

  def test_connect(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    ssh_url = parameter_dict['ssh-url']
    parsed = urlparse(ssh_url)
    self.assertEqual('ssh', parsed.scheme)

    # username contain a fingerprint (only, so we simplify the parsing)
    #
    # relevant parts of the grammar defined in
    # https://tools.ietf.org/id/draft-salowey-secsh-uri-00.html
    #
    #   ssh-info      =  [ userinfo ] [";" c-param *("," c-param)]
    #   c-param       =  paramname "=" paramvalue
    ssh_info = parsed.username
    username, fingerprint_from_url = ssh_info.split(';fingerprint=')
    client = paramiko.SSHClient()

    self.assertTrue(fingerprint_from_url.startswith('ssh-rsa-'), '')
    fingerprint_from_url = fingerprint_from_url[len('ssh-rsa-'):]

    class KeyPolicy(object):
      """Accept server key and keep it in self.key for inspection
      """
      def missing_host_key(self, client, hostname, key):
        self.key = key

    key_policy = KeyPolicy()
    client.set_missing_host_key_policy(key_policy)

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    for ssh_key in self.ssh_key_list:
      with contextlib.closing(client):
        client.connect(
            username=username,
            hostname=parsed.hostname,
            port=parsed.port,
            pkey=ssh_key,
        )
        # Check fingerprint from server matches the published one.
        # Paramiko does not allow to get the fingerprint as SHA256 easily yet
        # https://github.com/paramiko/paramiko/pull/1103
        self.assertEqual(
            fingerprint_from_url,
            quote(
                # base64 encoded fingerprint adds an extra = at the end
                base64.b64encode(
                    hashlib.sha256(key_policy.key.asbytes()).digest())[:-1],
                # also encode /
                safe=''))

        # Check shell is usable
        channel = client.invoke_shell()
        channel.settimeout(30)
        received = ''
        while True:
          r = bytes2str(channel.recv(1024))
          self.logger.debug("received >%s<", r)
          if not r:
            break
          received += r
          if 'slaprunner shell' in received:
            break
        self.assertIn("Welcome to SlapOS slaprunner shell", received)

        # simple commands can also be executed ( this would be like `ssh bash -c 'pwd'` )
        self.assertEqual(
            self.computer_partition_root_path,
            bytes2str(client.exec_command("pwd")[1].read(1000)).strip())
416 417


418 419 420 421
class TestSlapOS(SlaprunnerTestCase):
  def test_slapos_command(self):
    # in ~/bin/slapos there is a wrapper setting configuration to use slapos from
    # the web runner.
422 423 424 425
    slapos = os.path.join(self.computer_partition_root_path, 'bin', 'slapos')
    # ensure the node is formatted
    subprocess.check_call((slapos, 'node', 'format', '--now'), env={})
    proxy_show_output = subprocess.check_output((slapos, 'proxy', 'show'), env={})
426
    self.assertIn(b'slaprunner', proxy_show_output)
427 428 429
    # check hateoas cli support
    computer_list_output = subprocess.check_output((slapos, 'computer', 'list'), env={})
    self.assertIn(b'slaprunner', computer_list_output)
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

  def test_shared_part_list(self):
    # this slapos used shared_part_list
    cfg_parser = ConfigParser()
    with open(os.path.join(self.computer_partition_root_path,
                           'etc',
                           'slapos.cfg')) as f:
      cfg_parser.readfp(f)
    shared_part_list = cfg_parser.get('slapos', 'shared_part_list').splitlines()

    # web runner own shared parts. Note that there is intentionnaly a double
    # slash in this path, because slaprunner has double slash in paths since
    # early releases, including for the path of slapos repository that will be
    # used to develop and install software. If we fix this duplication, then
    # the URL of installed software will be different and it will get a different
    # hash and be reinstalled. To prevent this, we keep that // between srv and runner.
    self.assertEqual(
        '{}/srv//runner//shared'.format(self.computer_partition_root_path.rstrip('/')),
        shared_part_list[-1])

    # shared parts from outer slapos
    outer_shared_part_list = os.getenv('SLAPOS_TEST_SHARED_PART_LIST',
                                       '').split(os.pathsep)
    for outer_shared_part in outer_shared_part_list:
      self.assertIn(outer_shared_part, shared_part_list)


457
class ServicesTestCase(SlaprunnerTestCase):
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
  def test_hashes(self):
    hash_files = [
      'software_release/buildout.cfg',
    ]
    expected_process_names = [
      'slaprunner-supervisord-{hash}-on-watch',
      'runner-sshd-{hash}-on-watch',
      'slaprunner-httpd-{hash}-on-watch',
      'gunicorn-{hash}-on-watch',
      'nginx-frontend-{hash}-on-watch',
      'certificate_authority-{hash}-on-watch',
      'shellinaboxd-{hash}-on-watch',
      'supervisord-{hash}-on-watch',
    ]

473 474 475 476
    with self.slap.instance_supervisor_rpc as supervisor:
      process_names = [
          process['name'] for process in supervisor.getAllProcessInfo()
      ]
477 478 479 480 481

    hash_files = [os.path.join(self.computer_partition_root_path, path)
                  for path in hash_files]

    for name in expected_process_names:
482
      h = generateHashFromFiles(hash_files)
483 484 485
      expected_process_name = name.format(hash=h)

      self.assertIn(expected_process_name, process_names)
486

487 488 489 490 491 492 493 494 495 496 497 498 499 500
class TestCustomFrontend(SlaprunnerTestCase):
  @classmethod
  def getInstanceParameterDict(cls):
    return {
      'custom-frontend-backend-url': 'https://www.erp5.com',
      'custom-frontend-backend-type': 'redirect',
    }

  def test(self):
    parameter_dict = self.computer_partition.getConnectionParameterDict()
    # slapproxy returns the backend URL when requesting a slave frontend
    self.assertEqual(
      parameter_dict['custom-frontend-url'],
      'https://www.erp5.com')
501

502
@skipIfPython3
503
class TestResilientInstance(SlaprunnerTestCase):
504
  instance_max_retry = 20
505

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'

  def test(self):
    # just check that keys returned on requested partition are for resilient
    self.assertSetEqual(
      set(self.computer_partition.getConnectionParameterDict().keys()),
      set([
        'backend-url',
        'feed-url-runner-1-pull',
        'feed-url-runner-1-push',
        'init-password',
        'init-user',
        'monitor-base-url',
        'monitor-setup-url',
        'public-url',
        'ssh-command',
        'takeover-runner-1-password',
        'takeover-runner-1-url',
        'url',
        'webdav-url']))
528

529
@skipIfPython3
530 531 532 533 534 535
class TestResilientCustomFrontend(TestCustomFrontend):
  instance_max_retry = 20
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'

536
@skipIfPython3
537 538 539 540 541 542 543 544 545 546
class TestResilientWebInstance(TestWeb):
  instance_max_retry = 20
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'

  def test_public_url(self):
    pass # Disable until we can write on runner0 rather them
         # on root partition

547
@skipIfPython3
548 549 550 551 552 553 554
class TestResilientWebrunnerBasicUsage(TestWebRunnerBasicUsage):
  instance_max_retry = 20
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'


555
@skipIfPython3
556 557 558 559 560 561
class TestResilientWebrunnerAutorun(TestWebRunnerAutorun):
  instance_max_retry = 20
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'

562
@skipIfPython3
563 564 565 566 567
class TestResilientDummyInstance(SlaprunnerTestCase):
  instance_max_retry = 20
  @classmethod
  def getInstanceSoftwareType(cls):
    return 'resilient'
568 569 570 571

  @classmethod
  def getInstanceParameterDict(cls):
    return {
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
        'resiliency-backup-periodicity': '*/6 * * * *',
        'auto-deploy-instance': 'false',
        'software-root': os.path.join(cls.slap._instance_root, "..", "soft"),
        'buildout-shared-folder': os.path.join(cls.slap._instance_root, "..", "shared"),
        'auto-deploy': 'true',
        # XXX HACK!
        "slapos-reference": 'slaprunner-erp5-resiliency',
        "slapos-httpd-port": '9687'
       }

  @unittest.skip('Skip as _getFileContent dont work for now')
  def test_basic_resilience(self):
    self._openSoftwareRelease()
    self._buildSoftwareRelease()
    self._waitForSoftwareBuild()
    self._deployInstance()
    self._waitForInstanceDeploy()

    result = self._getFileContent(
      "instance_root/slappart0/var/log/log.log")

    self.assertTrue(result.startswith("Hello"), result)

    # We should ensure here that the resilience was indeed
    # Propagates and test succeeded.
    time.sleep(900)

    self._waitForCloneToBeReadyForTakeover()
    self._doTakeover()
    self.slap.waitForInstance(20) 

    previous_computer_partition = self.computer_partition
    self.computer_partition = self.requestDefaultInstance()


    result_after = self._getFileContent(
      "instance_root/slappart0/var/log/log.log")

    self.assertTrue(result_after.startswith("Hello"), result_after)

    self.assertIn(result, result_after,
            "%s not in %s" % (result, result_after))