test_promise.py 76.1 KB
Newer Older
1
# -*- coding: utf-8 -*-
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 33 34
##############################################################################
#
# Copyright (c) 2018 Vifib SARL 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, shutil
import tempfile
import unittest
import sys
import time
import json
import random
35
import logging
36
from datetime import datetime, timedelta
Bryton Lacquement's avatar
Bryton Lacquement committed
37 38
import six
from six.moves import queue
39 40
from slapos.grid.promise import (interface, PromiseLauncher, PromiseProcess,
                                 PromiseError, PROMISE_CACHE_FOLDER_NAME)
41 42
from slapos.grid.promise.generic import (GenericPromise, TestResult, AnomalyResult,
                                         PromiseQueueResult, PROMISE_STATE_FOLDER_NAME,
43
                                         PROMISE_HISTORY_RESULT_FOLDER_NAME,
44 45
                                         PROMISE_RESULT_FOLDER_NAME,
                                         PROMISE_PARAMETER_NAME)
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

class TestSlapOSPromiseMixin(unittest.TestCase):

  def setUp(self):
    self.partition_dir = tempfile.mkdtemp()
    self.plugin_dir = os.path.join(self.partition_dir, 'plugins')
    self.legacy_promise_dir = os.path.join(self.partition_dir, 'promise')
    self.log_dir = os.path.join(self.partition_dir, 'log')
    os.mkdir(self.plugin_dir)
    os.mkdir(self.log_dir)
    os.makedirs('%s/.slapgrid/promise' % self.partition_dir)
    os.mkdir(self.legacy_promise_dir)
    self.partition_id = "slappart0"
    self.computer_id = "COMP-1234"

  def writeInit(self):
    with open(os.path.join(self.plugin_dir, '__init__'), 'w') as f:
      f.write('')
Bryton Lacquement's avatar
Bryton Lacquement committed
64
    os.chmod(os.path.join(self.plugin_dir, '__init__'), 0o644)
65 66 67 68 69 70 71 72 73
    if sys.path[0] != self.plugin_dir:
      sys.path[0:0] = [self.plugin_dir]

  def tearDown(self):
    if os.path.exists(self.partition_dir):
      shutil.rmtree(self.partition_dir)
    if sys.path[0] == self.plugin_dir:
      del sys.path[0]

74
  def configureLauncher(self, save_method=None, timeout=5, master_url="", debug=False,
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
      run_list=[], uid=None, gid=None, enable_anomaly=False, force=False,
      logdir=True, dry_run=False):
    parameter_dict = {
      'promise-timeout': timeout,
      'promise-folder': self.plugin_dir,
      'legacy-promise-folder': self.legacy_promise_dir,
      'log-folder': self.log_dir if logdir else None,
      'partition-folder': self.partition_dir,
      'master-url': master_url,
      'partition-cert': "",
      'partition-key': "",
      'partition-id': self.partition_id,
      'computer-id': self.computer_id,
      'debug': debug,
      'check-anomaly': enable_anomaly,
      'force': force,
      'run-only-promise-list': run_list,
      'uid': uid,
      'gid': gid
    }

    self.launcher = PromiseLauncher(
      config=parameter_dict,
98
      logger=logging.getLogger('slapos.test.promise'),
99 100 101 102 103
      dry_run=dry_run
    )
    if save_method:
      self.launcher._savePromiseResult = save_method

104 105 106 107 108 109 110 111 112 113 114 115
  def genPromiseConfigDict(self, promise_name):
    return {
      'log-folder': None,
      'partition-folder': self.partition_dir,
      'master-url': "https://master.url.com",
      'partition-cert': "",
      'partition-key': "",
      'partition-id': self.partition_id,
      'computer-id': self.computer_id,
      'debug': False,
      'name': promise_name,
      'path': os.path.join(self.plugin_dir, promise_name),
Bryton Lacquement's avatar
Bryton Lacquement committed
116
      'queue': queue.Queue(),
117 118 119 120 121 122 123 124 125
    }

  def createPromiseProcess(self, promise_name, check_anomaly=False, wrap=False):

    promise_path = os.path.join(self.plugin_dir, promise_name)
    return PromiseProcess(
      self.partition_dir,
      promise_name,
      promise_path,
126
      logger=logging.getLogger('slapos.test.promise'),
127 128 129 130 131
      argument_dict=self.genPromiseConfigDict(promise_name),
      check_anomaly=check_anomaly,
      wrap=wrap,
    )

Bryton Lacquement's avatar
Bryton Lacquement committed
132
  def writeFile(self, path, content, mode=0o644):
133 134 135 136 137
    with open(path, 'w') as f:
      f.write(content)
    os.chmod(path, mode)

  def generatePromiseScript(self, name, success=True, failure_count=1, content="",
138
    periodicity=0.03, is_tested=True, with_anomaly=True):
Bryton Lacquement's avatar
Bryton Lacquement committed
139
    promise_content = """from zope.interface import implementer
140 141 142
from slapos.grid.promise import interface
from slapos.grid.promise import GenericPromise

Bryton Lacquement's avatar
Bryton Lacquement committed
143
@implementer(interface.IPromise)
144 145 146 147 148
class RunPromise(GenericPromise):

  def __init__(self, config):
    GenericPromise.__init__(self, config)
    self.setPeriodicity(minute=%(periodicity)s)
149 150 151 152
    if not %(is_tested)s:
      self.setTestLess()
    if not %(with_anomaly)s:
      self.setAnomalyLess()
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168

  def sense(self):
    %(content)s

    if not %(success)s:
      self.logger.error("failed")
    else:
      self.logger.info("success")

  def anomaly(self):
    return self._anomaly(latest_minute=%(periodicity)s, failure_amount=%(failure_amount)s)

  def test(self):
    return self._test(latest_minute=%(periodicity)s, failure_amount=%(failure_amount)s)

""" % {'success': success, 'content': content, 'failure_amount': failure_count,
169
       'periodicity': periodicity, 'is_tested': is_tested, 'with_anomaly': with_anomaly}
170 171 172 173

    with open(os.path.join(self.plugin_dir, name), 'w') as f:
      f.write(promise_content)

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
  def assertSuccessResult(self, name):
    expected_result = """{
  "result": {
    "failed": false,
    "message": "success",
    "type": "Test Result"
  },
  "path": "%(promise_dir)s/%(name)s.py",
  "name": "%(name)s.py",
  "title": "%(name)s"
}"""

    # first promise
    state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME, '%s.status.json' % name)
    self.assertTrue(os.path.exists(state_file))
    with open(state_file) as f:
      result_dict = json.loads(f.read())
      result_dict['result'].pop('date')
192 193 194 195
      # execution time of a promise can vary from 0.05 to 0.2 in a busy test machine
      # it makes no sense to test it
      execution_time = result_dict.pop('execution-time')
      self.assertTrue(execution_time > 0.0 and execution_time <=1.0)
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
      expected_dict = expected_result % {'promise_dir': self.plugin_dir, 'name': name}
      self.assertEqual(json.loads(expected_dict), result_dict)


  def assertSuccessHistoryResult(self, name, expected_history=None):
    if not expected_history:
      expected_history = """{
	"data": [{
		"failed": false,
		"message": "success",
		"name": "%(name)s.py",
		"status": "OK",
		"title": "%(name)s"
	}]
}"""
211

212 213 214 215 216 217 218 219
    history_file = os.path.join(self.partition_dir, PROMISE_HISTORY_RESULT_FOLDER_NAME, '%s.history.json' % name)
    self.assertTrue(os.path.exists(history_file))
    with open(history_file) as f:
      result_dict = json.loads(f.read())
      result_dict.pop('date')
      for entry in result_dict["data"]:
        d = entry.pop("date")
        self.assertEqual(d, entry.pop("change-date"))
220 221 222 223
        # execution time of a promise can vary from 0.05 to 0.2 in a busy test machine
        # it makes no sense to test it
        execution_time = entry.pop("execution-time")
        self.assertTrue(execution_time > 0.0 and execution_time <=1.0)
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

      expected_dict = expected_history % {'name': name}
      self.assertEqual(json.loads(expected_dict), result_dict)

  def assertSuccessStatsResult(self, success=1, error=0, expected_stats=None):
    if not expected_stats:
      expected_stats = """{
	"data": ["Date, Success, Error, Warning",
                "__DATE__, %(success)s, %(error)s, "
	]
}"""

    stats_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME, 'promise_stats.json')
    self.assertTrue(os.path.exists(stats_file))
    with open(stats_file) as f:
      result_dict = json.loads(f.read())
      result_dict.pop('date')
      expected_dict = expected_stats % {'success': success, "error": error}
      copy = result_dict["data"]
      for nline in range(1, len(result_dict["data"])):
        line = result_dict["data"][nline]
        result_dict["data"][nline] = "__DATE__,%s" % ",".join(line.split(',')[1:])
      self.assertEqual(json.loads(expected_dict), result_dict)
247 248 249 250 251 252

class TestSlapOSPromiseLauncher(TestSlapOSPromiseMixin):

  def test_promise_match_interface(self):
    promise_name = 'my_promise.py'
    self.writeInit()
253 254
    self.generatePromiseScript(promise_name)
    promise_process = self.createPromiseProcess(promise_name)
255

256
    promise_module = promise_process._loadPromiseModule()
257 258 259 260

  def test_promise_match_interface_bad_name(self):
    promise_name = 'my_promise_no_py'
    self.writeInit()
261 262
    self.generatePromiseScript(promise_name)
    promise_process = self.createPromiseProcess(promise_name)
263

264 265
    with self.assertRaises(ImportError) as exc:
      promise_module = promise_process._loadPromiseModule()
Bryton Lacquement's avatar
Bryton Lacquement committed
266 267 268
    self.assertEqual(str(exc.exception), 'No module named %s' %
                                          ("'%s'" % promise_name if six.PY3 else
                                           promise_name))
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

  def test_promise_match_interface_no_implement(self):
    promise_name = 'my_promise_noimplement.py'
    promise_content = """from slapos.grid.promise import GenericPromise

class RunPromise(GenericPromise):

  def __init__(self, config):
    GenericPromise.__init__(self, config)

  def sense(self):
    pass
    
"""
    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
285 286
    self.writeInit()
    promise_process = self.createPromiseProcess(promise_name)
287

288 289
    with self.assertRaises(RuntimeError) as exc:
      promise_module = promise_process._loadPromiseModule()
Bryton Lacquement's avatar
Bryton Lacquement committed
290 291 292
    message = "RunPromise class in my_promise_noimplement.py must implement" \
      " 'IPromise' interface. @implementer(interface.IPromise) is missing ?"
    self.assertEqual(str(exc.exception), message)
293 294 295

  def test_promise_match_interface_no_generic(self):
    promise_name = 'my_promise_nogeneric.py'
Bryton Lacquement's avatar
Bryton Lacquement committed
296
    promise_content = """from zope.interface import implementer
297 298
from slapos.grid.promise import interface

Bryton Lacquement's avatar
Bryton Lacquement committed
299
@implementer(interface.IPromise)
300 301 302 303 304 305 306 307 308 309 310
class RunPromise(object):

  def __init__(self, config):
    pass

  def sense(self):
    pass
    
"""
    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
311 312
    self.writeInit()
    promise_process = self.createPromiseProcess(promise_name)
313

314 315 316
    with self.assertRaises(RuntimeError) as exc:
      promise_module = promise_process._loadPromiseModule()

Bryton Lacquement's avatar
Bryton Lacquement committed
317
    self.assertEqual(str(exc.exception), 'RunPromise class is not a subclass of GenericPromise class.')
318 319 320

  def test_promise_match_interface_no_sense(self):
    promise_name = 'my_promise_nosense.py'
Bryton Lacquement's avatar
Bryton Lacquement committed
321
    promise_content = """from zope.interface import implementer
322 323 324
from slapos.grid.promise import interface
from slapos.grid.promise import GenericPromise

Bryton Lacquement's avatar
Bryton Lacquement committed
325
@implementer(interface.IPromise)
326 327 328 329 330 331 332 333 334 335 336
class RunPromise(GenericPromise):

  def __init__(self, config):
    pass

  def noSenseMethod(self):
    pass
    
"""
    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
337 338
    self.writeInit()
    promise_process = self.createPromiseProcess(promise_name)
339

340 341
    with self.assertRaises(TypeError) as exc:
      promise_module = promise_process._loadPromiseModule()
342
      promise = promise_module.RunPromise({})
343 344 345 346 347 348

    expected_assertion_message = "Can't instantiate abstract class RunPromise with abstract method sense"
    if sys.version_info < (3, 9):
      expected_assertion_message = "Can't instantiate abstract class RunPromise with abstract methods sense"

    self.assertEqual(str(exc.exception), expected_assertion_message)
349 350 351 352 353

  def test_promise_extra_config(self):
    promise_name = 'my_promise_extra.py'
    config_dict = {'foo': 'bar', 'my-config': 4522111,
                   'text': 'developers \ninformation, sample\n\ner'}
Bryton Lacquement's avatar
Bryton Lacquement committed
354
    promise_content = """from zope.interface import implementer
355 356 357 358 359
from slapos.grid.promise import interface
from slapos.grid.promise import GenericPromise

%(config_name)s = %(config_content)s

Bryton Lacquement's avatar
Bryton Lacquement committed
360
@implementer(interface.IPromise)
361 362 363 364 365 366 367 368 369 370 371 372 373 374
class RunPromise(GenericPromise):

  def sense(self):
    pass
    
""" % {'config_name': PROMISE_PARAMETER_NAME,
       'config_content': config_dict}
    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
    self.writeInit()
    promise_process = self.createPromiseProcess(promise_name)
    promise_module = promise_process._loadPromiseModule()
    promise = promise_module.RunPromise(promise_process.argument_dict)

375 376 377
    self.assertEqual(promise.getConfig('foo'), 'bar')
    self.assertEqual(promise.getConfig('my-config'), 4522111)
    self.assertEqual(promise.getConfig('text'), config_dict['text'])
378 379 380

  def test_promise_extra_config_reserved_name(self):
    promise_name = 'my_promise_extra.py'
Bryton Lacquement's avatar
Bryton Lacquement committed
381 382 383 384 385
    from collections import OrderedDict
    config_dict = OrderedDict([('name', 'bar'), ('my-config', 4522111)])
    promise_content = """from collections import OrderedDict

from zope.interface import implementer
386 387 388 389 390
from slapos.grid.promise import interface
from slapos.grid.promise import GenericPromise

%(config_name)s = %(config_content)s

Bryton Lacquement's avatar
Bryton Lacquement committed
391
@implementer(interface.IPromise)
392 393 394 395 396 397 398 399 400 401 402 403 404 405
class RunPromise(GenericPromise):

  def sense(self):
    pass
    
""" % {'config_name': PROMISE_PARAMETER_NAME,
       'config_content': config_dict}
    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
    self.writeInit()
    promise_process = self.createPromiseProcess(promise_name)

    with self.assertRaises(ValueError) as exc:
      promise_module = promise_process._loadPromiseModule()
Bryton Lacquement's avatar
Bryton Lacquement committed
406
    self.assertEqual(str(exc.exception), "Extra parameter name 'name' cannot be used.\n%s" % config_dict)
407 408 409 410 411 412 413 414 415 416 417

  def test_runpromise(self):
    promise_name = 'my_promise.py'
    self.configureLauncher()
    self.generatePromiseScript(promise_name, success=True)
    state_folder = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_folder))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
418

419 420 421
    self.assertSuccessResult("my_promise")
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessStatsResult(1)
422 423 424 425 426 427 428 429 430 431 432 433 434 435

  def test_runpromise_multiple(self):
    promise_name = 'my_promise.py'
    second_name = 'my_second_promise.py'
    self.configureLauncher()
    self.generatePromiseScript(promise_name, success=True)
    self.generatePromiseScript(second_name, success=True)
    state_folder = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_folder))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))

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 463 464 465 466 467 468 469 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 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 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
    self.assertSuccessResult("my_promise")
    self.assertSuccessResult("my_second_promise")

    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessHistoryResult("my_second_promise")
    self.assertSuccessStatsResult(2)

  def test_runpromise_multiple_times_same_promise(self):
    promise_name = 'my_promise.py'
    self.configureLauncher()
    self.generatePromiseScript(promise_name, success=True)
    state_folder = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    time.sleep(1)
    self.launcher.run()
    time.sleep(1)
    self.launcher.run()
    time.sleep(1)
    self.assertTrue(os.path.exists(state_folder))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))

    self.assertSuccessResult("my_promise")
    self.assertSuccessHistoryResult("my_promise", expected_history = """{
        "data": [{
                "failed": false,
                "message": "success",
                "name": "%(name)s.py",
                "status": "OK",
                "title": "%(name)s"
        },{
                "failed": false,
                "message": "success",
                "status": "OK"
        }]
}""")

    self.assertSuccessStatsResult(1, expected_stats = """{
        "data": ["Date, Success, Error, Warning",
                "__DATE__, %(success)s, %(error)s, ",
                "__DATE__, %(success)s, %(error)s, ",
                "__DATE__, %(success)s, %(error)s, "
        ]
}""")

  def test_runpromise_multiple_times_same_promise_with_failure(self):
    promise_name = 'my_promise.py'
    self.configureLauncher()
    self.generatePromiseScript(promise_name, success=True)
    state_folder = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    time.sleep(1)
    self.generatePromiseScript(promise_name, success=False)
    time.sleep(1)
    with self.assertRaises(PromiseError):
      self.launcher.run()
    time.sleep(1)
    with self.assertRaises(PromiseError):
      self.launcher.run()
    time.sleep(1)
    self.assertTrue(os.path.exists(state_folder))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))

    self.assertSuccessHistoryResult("my_promise", expected_history = """{
        "data": [{
                "failed": false,
                "message": "success",
                "name": "%(name)s.py",
                "status": "OK",
                "title": "%(name)s"
        },{
                "failed": true,
                "message": "failed",
                "status": "ERROR"
        }]
}""")
    self.assertSuccessStatsResult(1, expected_stats = """{
        "data": ["Date, Success, Error, Warning",
                "__DATE__, %(success)s, %(error)s, ",
                "__DATE__, 0, 1, ",
                "__DATE__, 0, 1, "
        ]
}""")

  def test_runpromise_multiple_times_same_promise_with_flaky_failures(self):
    promise_name = 'my_promise.py'
    self.configureLauncher()
    self.generatePromiseScript(promise_name, success=True)
    state_folder = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    time.sleep(1)
    self.generatePromiseScript(promise_name, success=False)
    time.sleep(1)
    with self.assertRaises(PromiseError):
      self.launcher.run()
    time.sleep(1)
    self.generatePromiseScript(promise_name, success=True)
    time.sleep(1)
    self.launcher.run()
    self.assertTrue(os.path.exists(state_folder))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
    self.maxDiff = None
    self.assertSuccessHistoryResult("my_promise", expected_history = """{
        "data": [{
                "failed": false,
                "message": "success",
                "name": "%(name)s.py",
                "status": "OK",
                "title": "%(name)s"
        },{
                "failed": true,
                "message": "failed",
                "status": "ERROR"
        },{
                "failed": false,
                "message": "success",
                "status": "OK"
        }]
}""")
    self.assertSuccessStatsResult(1, expected_stats = """{
        "data": ["Date, Success, Error, Warning",
                "__DATE__, %(success)s, %(error)s, ",
                "__DATE__, 0, 1, ",
                "__DATE__, %(success)s, %(error)s, "
        ]
}""")
567 568


569 570 571 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
  def test_runpromise_with_currupted_history(self):
    promise_name = 'my_promise'
    self.configureLauncher()
    self.generatePromiseScript('my_promise.py', success=True, periodicity=0.03)

    self.launcher.run()
    self.assertSuccessResult(promise_name)

    # will fail if history json is broken
    self.assertSuccessHistoryResult(promise_name)
    history_file = os.path.join(self.partition_dir,
                                PROMISE_HISTORY_RESULT_FOLDER_NAME,
                                '%s.history.json' % promise_name)
    stats_file = os.path.join(self.partition_dir,
                              PROMISE_STATE_FOLDER_NAME,
                              'promise_stats.json')
    broken_history = """{
	"data": [{
		"failed": false,
		"message": "success",
		"name": "%(name)s.py",
		"status": "OK",
		"title": "%(name)s"
	}, {]
}""" % {'name': promise_name}

    with open(history_file, 'w') as f:
      f.write(broken_history)
    with open(stats_file, 'w') as f:
      f.write("""{
	"data": ["Date, Success,
""")
    time.sleep(4)

    with self.assertRaises(ValueError):
      self.assertSuccessHistoryResult(promise_name)
    with self.assertRaises(ValueError):
      self.assertSuccessStatsResult(1)

    self.launcher.run()
    self.assertSuccessResult(promise_name)
    # Promise history json is not broken anymore
    self.assertSuccessHistoryResult(promise_name)
    # Statistics data file is not broken anymore
    self.assertSuccessStatsResult(1)
614 615 616 617 618 619 620 621 622 623 624 625

  def test_runpromise_no_logdir(self):
    promise_name = 'my_promise.py'
    # no promise log output dir
    self.configureLauncher(logdir=False)
    self.generatePromiseScript(promise_name, success=True)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_file))
    self.assertFalse(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
626 627
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessStatsResult(1)
628 629 630 631 632 633 634

  def test_runpromise_savemethod(self):
    promise_name = 'my_promise.py'
    def test_method(result):
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
      self.assertTrue(result.execution_time != 0)
635 636 637 638 639
      self.assertEqual(result.title, 'my_promise')
      self.assertEqual(result.name, promise_name)
      self.assertEqual(result.path, os.path.join(self.plugin_dir, promise_name))
      self.assertEqual(result.item.message, "success")
      self.assertEqual(result.item.hasFailed(), False)
640 641 642 643 644 645 646 647 648 649 650
      self.assertTrue(isinstance(result.item.date, datetime))

    self.configureLauncher(save_method=test_method)
    self.generatePromiseScript(promise_name, success=True)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_file))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))

651 652 653
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessStatsResult(1)

654 655 656 657 658 659
  def test_runpromise_savemethod_no_logdir(self):
    promise_name = 'my_promise.py'
    def test_method(result):
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
      self.assertTrue(result.execution_time != 0)
660 661 662 663 664
      self.assertEqual(result.title, 'my_promise')
      self.assertEqual(result.name, promise_name)
      self.assertEqual(result.path, os.path.join(self.plugin_dir, promise_name))
      self.assertEqual(result.item.message, "success")
      self.assertEqual(result.item.hasFailed(), False)
665 666 667 668 669 670 671 672 673 674 675
      self.assertTrue(isinstance(result.item.date, datetime))

    # no promise log output dir
    self.configureLauncher(logdir=False, save_method=test_method)
    self.generatePromiseScript(promise_name, success=True)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_file))
    self.assertFalse(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
676 677 678
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessStatsResult(1)

679 680 681 682 683 684 685

  def test_runpromise_savemethod_anomaly(self):
    promise_name = 'my_promise.py'
    def test_method(result):
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, AnomalyResult))
      self.assertTrue(result.execution_time != 0)
686 687 688 689 690
      self.assertEqual(result.title, 'my_promise')
      self.assertEqual(result.name, promise_name)
      self.assertEqual(result.path, os.path.join(self.plugin_dir, promise_name))
      self.assertEqual(result.item.message, "success")
      self.assertEqual(result.item.hasFailed(), False)
691 692 693 694 695 696 697 698 699 700
      self.assertTrue(isinstance(result.item.date, datetime))

    self.configureLauncher(save_method=test_method, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
    self.assertTrue(os.path.exists(state_file))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
701 702 703
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessStatsResult(1)

704 705 706 707 708 709 710 711

  def test_runpromise_savemethod_multiple(self):
    promise_name = 'my_promise.py'
    promise_failed = 'my_failed_promise.py'
    self.counter = 0
    def test_method(result):
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
712
      self.assertIn(result.name, [promise_failed, promise_name])
713
      if result.name == promise_failed:
714 715
        self.assertEqual(result.item.hasFailed(), True)
        self.assertEqual(result.item.message, "failed")
716
      else:
717 718
        self.assertEqual(result.item.hasFailed(), False)
        self.assertEqual(result.item.message, "success")
719 720 721 722 723 724 725 726 727
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    self.generatePromiseScript(promise_name, success=True)
    self.generatePromiseScript(promise_failed, success=False)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    with self.assertRaises(PromiseError):
      self.launcher.run()
728
    self.assertEqual(self.counter, 2)
729 730 731 732
    self.assertTrue(os.path.exists(state_file))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_promise.log')))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_failed_promise.log')))

733 734 735 736 737 738 739 740 741 742 743 744
    self.assertSuccessHistoryResult("my_promise")
    self.assertSuccessHistoryResult("my_failed_promise", expected_history = """{
        "data": [{
                "failed": true,
                "message": "failed",
                "name": "%(name)s.py",
                "status": "ERROR",
                "title": "%(name)s"
        }]
}""")
    self.assertSuccessStatsResult(success=1, error=1)

745 746 747 748 749 750 751 752
  def test_runpromise_savemethod_multiple_success(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    third_promise = 'my_third_promise.py'
    self.counter = 0
    def test_method(result):
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
753
      self.assertIn(result.name, [first_promise, second_promise, third_promise])
754 755
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
756 757 758 759 760 761 762 763 764 765
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    self.generatePromiseScript(first_promise, success=True)
    self.generatePromiseScript(second_promise, success=True)
    self.generatePromiseScript(third_promise, success=True)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)

    # run promise will not fail
    self.launcher.run()
766
    self.assertEqual(self.counter, 3)
767 768 769 770 771
    self.assertTrue(os.path.exists(state_file))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_first_promise.log')))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_second_promise.log')))
    self.assertTrue(os.path.exists(os.path.join(self.log_dir, 'my_third_promise.log')))

772 773 774 775 776 777
    self.assertSuccessHistoryResult("my_first_promise")
    self.assertSuccessHistoryResult("my_second_promise")
    self.assertSuccessHistoryResult("my_third_promise")

    self.assertSuccessStatsResult(3)

778 779 780 781 782 783 784 785 786 787 788
  def test_runpromise_fail_and_success(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'

    self.configureLauncher()
    self.generatePromiseScript(first_promise, success=True)
    self.generatePromiseScript(second_promise, success=False)

    # run promise will fail when promise fail (usefull for slapgrid)
    with self.assertRaises(PromiseError) as exc:
      self.launcher.run()
789
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
790

791 792
    # force to reload the module without rerun python
    os.system('rm %s/*.pyc' % self.plugin_dir)
793 794 795 796 797 798 799 800 801 802 803 804 805
    self.generatePromiseScript(second_promise, success=True)
    # wait next periodicity
    time.sleep(2)
    self.launcher.run()

    log_file = os.path.join(self.log_dir, 'my_second_promise.log')
    self.assertTrue(os.path.exists(log_file))
    with open(log_file) as f:
      line = f.readline()
      self.assertTrue('failed' in line, line)
      line = f.readline()
      self.assertTrue('success' in line, line)

806 807 808 809 810 811
    self.assertSuccessStatsResult(expected_stats = """{
        "data": ["Date, Success, Error, Warning",
                "__DATE__, 1, 1, ",
                "__DATE__, 2, 0, "
        ]
}""")
812 813 814 815 816 817 818

  def test_runpromise_with_periodicity(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    self.counter = 0

    def test_method_first(result):
819
      self.assertIn(result.name, [first_promise, second_promise])
820 821
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
822 823 824 825
      self.counter += 1

    def test_method_one(result):
      self.counter += 1
826 827 828
      self.assertEqual(result.name, first_promise)
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
829 830 831 832 833 834 835 836

    self.configureLauncher(save_method=test_method_first)
    # ~2 seconds
    self.generatePromiseScript(first_promise, success=True, periodicity=0.03)
    # ~3 seconds
    self.generatePromiseScript(second_promise, success=True, periodicity=0.05)

    self.launcher.run()
837
    self.assertEqual(self.counter, 2)
838 839 840 841 842

    self.configureLauncher(save_method=test_method_one)
    time.sleep(2)
    self.counter = 0
    self.launcher.run() # only my_first_promise will run
843
    self.assertEqual(self.counter, 1)
844 845 846 847 848

    time.sleep(3)
    self.counter = 0
    self.configureLauncher(save_method=test_method_first)
    self.launcher.run()
849
    self.assertEqual(self.counter, 2)
850 851 852 853 854 855 856

  def test_runpromise_with_periodicity_same(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    self.counter = 0

    def test_method(result):
857
      self.assertIn(result.name, [first_promise, second_promise])
858 859
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
860 861 862 863 864 865 866 867
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    # ~2 seconds
    self.generatePromiseScript(first_promise, success=True, periodicity=0.03)
    self.generatePromiseScript(second_promise, success=True, periodicity=0.03)

    self.launcher.run()
868
    self.assertEqual(self.counter, 2)
869 870 871 872 873

    self.configureLauncher(save_method=test_method)
    time.sleep(1)
    self.counter = 0
    self.launcher.run() # run nothing
874
    self.assertEqual(self.counter, 0)
875 876 877 878 879

    time.sleep(1)
    self.counter = 0
    self.configureLauncher(save_method=test_method)
    self.launcher.run()
880
    self.assertEqual(self.counter, 2)
881

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
  def test_runpromise_with_periodicity_result_failed(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    first_state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME,
                                    'my_first_promise.status.json')
    second_state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME,
                                     'my_second_promise.status.json')

    self.configureLauncher()
    # ~2 seconds
    self.generatePromiseScript(first_promise, success=True, periodicity=0.03)
    # ~3 seconds
    self.generatePromiseScript(second_promise, success=False, periodicity=0.05)

    with self.assertRaises(PromiseError) as exc:
      self.launcher.run()
898
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
899 900 901

    self.assertTrue(os.path.exists(first_state_file))
    self.assertTrue(os.path.exists(second_state_file))
902 903 904 905
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
906 907
    self.assertEqual(first_result['name'], first_promise)
    self.assertEqual(second_result['name'], second_promise)
908 909 910 911 912 913 914
    first_date = first_result['result']['date']
    second_date = second_result['result']['date']

    self.configureLauncher()
    time.sleep(2)
    with self.assertRaises(PromiseError) as exc:
      self.launcher.run() # only my_first_promise will run but second_promise still failing
915
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
916

917 918 919 920
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
921
    self.assertNotEqual(first_result['result']['date'], first_date)
922
    self.assertEqual(second_result['result']['date'], second_date)
923 924 925 926 927 928
    first_date = first_result['result']['date']

    time.sleep(3)
    self.configureLauncher()
    with self.assertRaises(PromiseError) as exc:
      self.launcher.run()
929
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
930

931 932 933 934
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
935 936
    self.assertNotEqual(first_result['result']['date'], first_date)
    self.assertNotEqual(second_result['result']['date'], second_date)
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953

  def test_runpromise_with_periodicity_result_failed_and_ok(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    first_state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME,
                                    'my_first_promise.status.json')
    second_state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME,
                                     'my_second_promise.status.json')

    self.configureLauncher()
    # ~2 seconds
    self.generatePromiseScript(first_promise, success=True, periodicity=0.03)
    # ~3 seconds
    self.generatePromiseScript(second_promise, success=False, periodicity=0.05)

    with self.assertRaises(PromiseError) as exc:
      self.launcher.run()
954
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
955 956 957

    self.assertTrue(os.path.exists(first_state_file))
    self.assertTrue(os.path.exists(second_state_file))
958 959 960 961
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
962 963
    self.assertEqual(first_result['name'], first_promise)
    self.assertEqual(second_result['name'], second_promise)
964 965 966 967 968 969 970
    first_date = first_result['result']['date']
    second_date = second_result['result']['date']

    self.configureLauncher()
    time.sleep(2)
    with self.assertRaises(PromiseError) as exc:
      self.launcher.run() # only my_first_promise will run but second_promise still failing
971
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: failed' % second_promise)
972

973 974 975 976
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
977
    self.assertNotEqual(first_result['result']['date'], first_date)
978
    self.assertEqual(second_result['result']['date'], second_date)
979 980 981 982
    first_date = first_result['result']['date']
    second_date = second_result['result']['date']

    time.sleep(4)
983 984
    # force to reload the module without rerun python
    os.system('rm %s/*.pyc' % self.plugin_dir)
985 986 987 988 989 990

    # second_promise is now success
    self.generatePromiseScript(second_promise, success=True, periodicity=0.05)
    self.configureLauncher()
    self.launcher.run() # now all succeed

991 992 993 994
    with open(first_state_file) as f:
      first_result = json.load(f)
    with open(second_state_file) as f:
      second_result = json.load(f)
995 996
    self.assertNotEqual(first_result['result']['date'], first_date)
    self.assertNotEqual(second_result['result']['date'], second_date)
997

998 999 1000 1001 1002 1003
  def test_runpromise_force(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    self.counter = 0

    def test_method(result):
1004
      self.assertIn(result.name, [first_promise, second_promise])
1005 1006
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
1007 1008 1009 1010 1011 1012 1013 1014
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    # ~2 seconds
    self.generatePromiseScript(first_promise, success=True, periodicity=0.03)
    self.generatePromiseScript(second_promise, success=True, periodicity=0.03)

    self.launcher.run()
1015
    self.assertEqual(self.counter, 2)
1016 1017 1018 1019 1020

    self.configureLauncher(save_method=test_method)
    time.sleep(1)
    self.counter = 0
    self.launcher.run() # run nothing
1021
    self.assertEqual(self.counter, 0)
1022 1023 1024 1025

    self.configureLauncher(save_method=test_method, force=True)
    self.counter = 0
    self.launcher.run() # will run all as force is True
1026
    self.assertEqual(self.counter, 2)
1027 1028 1029 1030 1031

    self.configureLauncher(save_method=test_method)
    time.sleep(1)
    self.counter = 0
    self.launcher.run() # run nothing
1032
    self.assertEqual(self.counter, 0)
1033 1034 1035 1036 1037

    time.sleep(1)
    self.counter = 0
    self.configureLauncher(save_method=test_method)
    self.launcher.run() # after 2 seconds will run all
1038
    self.assertEqual(self.counter, 2)
1039 1040 1041 1042 1043 1044 1045 1046 1047

  def test_runpromise_wrapped(self):
    promise_name = "my_bash_promise"
    promise_path = os.path.join(self.legacy_promise_dir, promise_name)
    self.called = False
    with open(promise_path, 'w') as f:
      f.write("""#!/bin/bash
echo "success"
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1048
    os.chmod(promise_path, 0o744)
1049 1050 1051 1052 1053 1054

    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
      self.assertTrue(result.execution_time != 0)
1055 1056 1057 1058 1059
      self.assertEqual(result.title, promise_name)
      self.assertEqual(result.name, promise_name)
      self.assertEqual(result.path, os.path.join(self.legacy_promise_dir, promise_name))
      self.assertEqual(result.item.message, "success")
      self.assertEqual(result.item.hasFailed(), False)
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
      self.assertTrue(isinstance(result.item.date, datetime))

    self.configureLauncher(save_method=test_method)
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)
    self.launcher.run()

    self.assertTrue(self.called)
    self.assertTrue(os.path.exists(state_file))

  def test_runpromise_wrapped_failed(self):
    promise_name = "my_bash_promise"
    promise_path = os.path.join(self.legacy_promise_dir, promise_name)
    with open(promise_path, 'w') as f:
      f.write("""#!/bin/bash
echo "This promise failed"
exit 1
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1077
    os.chmod(promise_path, 0o744)
1078 1079 1080 1081 1082

    self.configureLauncher()
    state_file = os.path.join(self.partition_dir, PROMISE_STATE_FOLDER_NAME)
    with self.assertRaises(PromiseError) as exc:
      self.launcher.run()
1083
    self.assertEqual(str(exc.exception), 'Promise %r failed with output: This promise failed' % promise_name)
1084 1085 1086 1087 1088 1089 1090 1091

  def test_runpromise_wrapped_mixed(self):
    self.called = 0
    result_dict = {"my_bash_promise": "", "my_bash_promise2": "", "first_promise.py": "", "second_promise.py": ""}
    def test_method(result):
      self.called += 1
      result_dict.pop(result.name)
      if result.title == "first_promise" or result.title == "second_promise":
1092
        self.assertEqual(result.item.message, "success")
1093
      if result.title == "my_bash_promise":
1094
        self.assertEqual(result.item.message, "promise 1 succeeded")
1095
      if result.title == "my_bash_promise2":
1096 1097
        self.assertEqual(result.item.message, "promise 2 succeeded")
      self.assertEqual(result.item.hasFailed(), False)
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107

    promise_name = "my_bash_promise"
    promise_path = os.path.join(self.legacy_promise_dir, promise_name)
    promise_name2 = "my_bash_promise2"
    promise_path2 = os.path.join(self.legacy_promise_dir, promise_name2)
    with open(promise_path, 'w') as f:
      f.write("""#!/bin/bash
echo "promise 1 succeeded"
exit 0
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1108
    os.chmod(promise_path, 0o744)
1109 1110 1111 1112 1113
    with open(promise_path2, 'w') as f:
      f.write("""#!/bin/bash
echo "promise 2 succeeded"
exit 0
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1114
    os.chmod(promise_path2, 0o744)
1115 1116 1117 1118 1119
    self.generatePromiseScript("first_promise.py", success=True)
    self.generatePromiseScript("second_promise.py", success=True)

    self.configureLauncher(save_method=test_method)
    self.launcher.run()
1120
    self.assertEqual(self.called, 4)
1121 1122 1123 1124 1125 1126 1127 1128 1129


  def test_runpromise_run_only(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    third_promise = 'my_third_promise.py'
    self.counter = 0
    self.check_list = [first_promise, second_promise, third_promise]
    def test_method(result):
1130
      self.assertIn(result.name, self.check_list)
1131 1132
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
1133 1134 1135 1136 1137 1138 1139 1140 1141
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    self.generatePromiseScript(first_promise, success=True)
    self.generatePromiseScript(second_promise, success=True)
    self.generatePromiseScript(third_promise, success=True)

    # run promise will not fail
    self.launcher.run()
1142
    self.assertEqual(self.counter, 3)
1143 1144 1145 1146 1147 1148

    self.counter = 0
    self.check_list = [second_promise]
    self.configureLauncher(save_method=test_method, run_list=[second_promise], force=True)
    time.sleep(1)
    self.launcher.run()
1149
    self.assertEqual(self.counter, 1)
1150 1151 1152 1153 1154 1155 1156 1157

  def test_runpromise_run_only_multiple(self):
    first_promise = 'my_first_promise.py'
    second_promise = 'my_second_promise.py'
    third_promise = 'my_third_promise.py'
    self.counter = 0
    self.check_list = [first_promise, second_promise, third_promise]
    def test_method(result):
1158
      self.assertIn(result.name, self.check_list)
1159 1160
      self.assertEqual(result.item.hasFailed(), False)
      self.assertEqual(result.item.message, "success")
1161 1162 1163 1164 1165 1166 1167 1168 1169
      self.counter += 1

    self.configureLauncher(save_method=test_method)
    self.generatePromiseScript(first_promise, success=True)
    self.generatePromiseScript(second_promise, success=True)
    self.generatePromiseScript(third_promise, success=True)

    # run promise will not fail
    self.launcher.run()
1170
    self.assertEqual(self.counter, 3)
1171 1172 1173 1174 1175 1176

    self.counter = 0
    self.check_list = [third_promise, second_promise]
    self.configureLauncher(save_method=test_method, run_list=self.check_list, force=True)
    time.sleep(1)
    self.launcher.run()
1177
    self.assertEqual(self.counter, 2)
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
  def writeLatestPromiseResult(self):
    state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME, 'my_promise.status.json')
    result_string = """{
  "result": {
    "failed": true,
    "message": "error",
    "date": "%s",
    "type": "Test Result"
  },
  "path": "%s/my_promise.py",
  "name": "my_promise.py",
1190
  "execution-time": 0.05,
1191
  "title": "my_promise"
1192
}""" % (datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S+0000'), self.plugin_dir)
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210

    if not os.path.exists(os.path.dirname(state_file)):
      os.makedirs(os.path.dirname(state_file))
    with open(state_file, 'w') as f:
      f.write(result_string)

  def writeLatestBashPromiseResult(self, name="my_bash_promise"):
    state_file = os.path.join(self.partition_dir, PROMISE_RESULT_FOLDER_NAME,
                              '%s.status.json' % name)
    result_string = """{
  "result": {
    "failed": true,
    "message": "error",
    "date": "%(date)s",
    "type": "Test Result"
  },
  "path": "%(folder)s/%(name)s",
  "name": "%(name)s",
1211
  "execution-time": 0.05,
1212
  "title": "%(name)s"
1213
}""" % {'date': datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S+0000'),
1214 1215 1216 1217 1218 1219 1220 1221
        'folder': self.legacy_promise_dir,
        'name': name}

    if not os.path.exists(os.path.dirname(state_file)):
      os.makedirs(os.path.dirname(state_file))
    with open(state_file, 'w') as f:
      f.write(result_string)

1222 1223 1224
  def test_runpromise_will_timeout(self):
    self.called = False
    promise_name = 'my_promise.py'
1225 1226
    self.writeLatestPromiseResult()

1227 1228 1229 1230 1231
    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, AnomalyResult))
      self.assertTrue(result.execution_time >= 1)
1232 1233
      self.assertEqual(result.title, 'my_promise')
      self.assertEqual(result.name, promise_name)
1234
      self.assertIn("Promise timed out after", result.item.message)
1235
      self.assertEqual(result.item.hasFailed(), True)
1236 1237 1238

    self.configureLauncher(save_method=test_method, enable_anomaly=True, timeout=1)
    self.generatePromiseScript(promise_name, success=True, content="""import time
1239
    time.sleep(20)""")
1240 1241 1242 1243 1244 1245

    # run promise will timeout
    with self.assertRaises(PromiseError):
      self.launcher.run()
    self.assertTrue(self.called)

1246 1247 1248
  def test_runpromise_wrapped_will_timeout(self):
    promise_name = "my_bash_promise"
    promise_path = os.path.join(self.legacy_promise_dir, promise_name)
1249
    self.writeLatestBashPromiseResult()
1250 1251 1252 1253 1254 1255
    self.called = False
    with open(promise_path, 'w') as f:
      f.write("""#!/bin/bash
sleep 20
echo "success"
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1256
    os.chmod(promise_path, 0o744)
1257 1258 1259 1260 1261 1262

    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))
      self.assertTrue(result.execution_time >= 1)
1263 1264 1265
      self.assertEqual(result.title, promise_name)
      self.assertEqual(result.name, promise_name)
      self.assertEqual(result.path, promise_path)
1266
      self.assertIn("Promise timed out after", result.item.message)
1267
      self.assertEqual(result.item.hasFailed(), True)
1268 1269 1270 1271 1272 1273 1274 1275
      self.assertTrue(isinstance(result.item.date, datetime))

    self.configureLauncher(save_method=test_method, timeout=1)
    # run promise will timeout
    with self.assertRaises(PromiseError):
      self.launcher.run()
    self.assertTrue(self.called)

1276 1277 1278 1279 1280
  def test_runpromise_wrapped_will_timeout_two(self):
    first_promise = "my_bash_promise"
    first_promise_path = os.path.join(self.legacy_promise_dir, first_promise)
    second_promise = "my_second_bash_promise"
    second_promise_path = os.path.join(self.legacy_promise_dir, second_promise)
1281 1282
    self.writeLatestBashPromiseResult(first_promise)
    self.writeLatestBashPromiseResult(second_promise)
1283 1284 1285 1286 1287 1288 1289 1290 1291

    def createPromise(promise_path):
      with open(promise_path, 'w') as f:
        f.write("""#!/bin/bash
echo "some data from promise"
sleep 20
echo "success"
exit 1
""")
Bryton Lacquement's avatar
Bryton Lacquement committed
1292
      os.chmod(promise_path, 0o744)
1293 1294 1295 1296 1297 1298 1299 1300

    createPromise(first_promise_path)
    createPromise(second_promise_path)
    self.configureLauncher(timeout=0.5)
    # run promise will timeout
    with self.assertRaises(PromiseError):
      self.launcher.run()

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
  def test_runpromise_timeout_fail_if_test(self):
    promise_name = 'my_promise.py'

    self.configureLauncher(timeout=1, enable_anomaly=False)
    self.generatePromiseScript(promise_name, success=True, content="""import time
    time.sleep(20)""", periodicity=0.01)

    # timeout for the first time and raise
    with self.assertRaises(PromiseError):
      self.launcher.run()

  def test_runpromise_fail_if_timeout_twice(self):
    promise_name = 'my_promise.py'

    self.configureLauncher(timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, content="""import time
    time.sleep(20)""", periodicity=0.01)

    # timeout for the first time, no raise
    self.launcher.run()

    # run promise will timeout and raise
    time.sleep(1)
    with self.assertRaises(PromiseError):
      self.launcher.run()

    # run promise will continue to raise
    time.sleep(1)
    with self.assertRaises(PromiseError):
      self.launcher.run()

1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
  def test_runpromise_not_tested(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True

    self.called = False
    self.configureLauncher(save_method=test_method, timeout=5, enable_anomaly=False)
    self.generatePromiseScript(promise_name, success=True, content="""import time
    time.sleep(20)""", periodicity=0.01, is_tested=False,)

    # will not run the promise in test mode (so no sleep)
    self.launcher.run()
    # no result returned by the promise
    self.assertFalse(self.called)

  def test_runpromise_not_tested_with_anomaly(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, AnomalyResult))

    self.called = False
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True,
      periodicity=0.01, is_tested=False,)

    # will run the promise because we are in anomaly mode
    self.launcher.run()
    # promise result is saved
    self.assertTrue(self.called)

  def test_runpromise_without_anomaly(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True

    self.called = False
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, content="""import time
    time.sleep(20)""", periodicity=0.01, with_anomaly=False,)

    # will not run the promise in anomaly mode (so no sleep)
    self.launcher.run()
    # no result returned by the promise
    self.assertFalse(self.called)

  def test_runpromise_without_anomaly_but_test(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, TestResult))

    self.called = False
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=False)
    self.generatePromiseScript(promise_name, success=True,
      periodicity=0.01, with_anomaly=False,)

    # will run the promise because we are in anomaly mode
    self.launcher.run()
    # promise result is saved
    self.assertTrue(self.called)

1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
  def test_runpromise_not_tested_will_not_change_periodicity(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True

    self.called = False

    self.configureLauncher(save_method=test_method, timeout=5, enable_anomaly=False)
    self.generatePromiseScript(promise_name, success=True, periodicity=5,
      is_tested=False,)

    # will not run the promise in test mode
    self.launcher.run()
    self.assertFalse(self.called)

    self.configureLauncher(save_method=test_method, timeout=5, enable_anomaly=True)
    # will not run immediately anomaly
    self.launcher.run()
    # no result returned by the promise
    self.assertTrue(self.called)

  def test_runpromise_without_anomaly_no_change_periodicity(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True

    self.called = False

    self.configureLauncher(save_method=test_method, timeout=5, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, periodicity=5,
      with_anomaly=False,)

    # will not run the promise in anomaly mode
    self.launcher.run()
    self.assertFalse(self.called)

    self.configureLauncher(save_method=test_method, timeout=5, enable_anomaly=False)
    # will not run immediately anomaly (periodicity didn't change)
    self.launcher.run()
    # no result returned by the promise
    self.assertTrue(self.called)

1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
  def test_runpromise_not_tested_without_anomaly_fail(self):
    promise_name = 'my_promise.py'

    def test_method(result):
      self.called = True
      self.assertTrue(isinstance(result, PromiseQueueResult))
      self.assertTrue(isinstance(result.item, AnomalyResult))
      self.assertEqual(result.item.message, "It's not allowed to disable both Test and Anomaly in promise!")
      self.assertEqual(result.item.hasFailed(), True)

    self.called = False
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, content="""import time
    time.sleep(20)""", periodicity=0.01, with_anomaly=False, is_tested=False)

    # will fail because disable anomaly and test is not allowed
    with self.assertRaises(PromiseError):
      self.launcher.run()
    # no result returned by the promise
    self.assertTrue(self.called)

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
  def test_promise_cache(self):
    promise_name = 'my_promise.py'
    promise_file = os.path.join(self.plugin_dir, promise_name)
    self.configureLauncher(timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, periodicity=0.01,
      with_anomaly=True, is_tested=False)

    # run promise, no failure
    self.launcher.run()
    cache_folder = os.path.join(self.partition_dir, PROMISE_CACHE_FOLDER_NAME)
    cache_file = os.path.join(cache_folder, 'my_promise')
    self.assertTrue(os.path.exists(cache_folder))
    self.assertTrue(os.path.exists(cache_file))
    file_stat = os.stat(promise_file)
    with open(cache_file) as f:
      cache_dict = json.load(f)
    timestamp = cache_dict.pop('timestamp')
    info_dict = {
      u'is_tested': False,
      u'is_anomaly_detected': True,
      u'periodicity': 0.01,
      u'next_run_after' : (timestamp + 0.01 * 60.0),
      u'module_file': u'%s' % promise_file,
      u'module_file_mtime': file_stat.st_mtime,
    }
    # next run is in future
    self.assertTrue(info_dict['next_run_after'] > time.time())
    self.assertEqual(info_dict, cache_dict)

  def test_promise_cache_expire_with_periodicity(self):
    self.called = False
    def test_method(result):
      self.called = True

    promise_name = 'my_promise.py'
    promise_file = os.path.join(self.plugin_dir, promise_name)
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.generatePromiseScript(promise_name, success=True, periodicity=0.01,
      with_anomaly=True, is_tested=False)

    # run promise, no failure
    self.launcher.run()
    cache_folder = os.path.join(self.partition_dir, PROMISE_CACHE_FOLDER_NAME)
    cache_file = os.path.join(cache_folder, 'my_promise')
    self.assertTrue(os.path.exists(cache_folder))
    self.assertTrue(os.path.exists(cache_file))
    file_stat = os.stat(promise_file)
    with open(cache_file) as f:
      cache_dict = json.load(f)
    timestamp = cache_dict.pop('timestamp')
    info_dict = {
      u'is_tested': False,
      u'is_anomaly_detected': True,
      u'periodicity': 0.01,
      u'next_run_after' : (timestamp + 0.01 * 60.0),
      u'module_file': u'%s' % promise_file,
      u'module_file_mtime': file_stat.st_mtime,
    }
    self.assertEqual(info_dict, cache_dict)
    self.assertTrue(self.called)
    next_run_after = cache_dict['next_run_after']

    # periodicity not match
    self.called = False
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.launcher.run()
    self.assertFalse(self.called)
    with open(cache_file) as f:
      cache_dict = json.load(f)
    # no change!
    current_timestamp = cache_dict.pop('timestamp')
    self.assertEqual(current_timestamp, timestamp)
    self.assertEqual(info_dict, cache_dict)

    time.sleep(1)
    # periodicity match
    self.configureLauncher(save_method=test_method, timeout=1, enable_anomaly=True)
    self.launcher.run()

    # cached was updated
    with open(cache_file) as f:
      cache_dict = json.load(f)
    new_timestamp = cache_dict.pop('timestamp')
    info_dict = {
      u'is_tested': False,
      u'is_anomaly_detected': True,
      u'periodicity': 0.01,
      u'next_run_after' : (new_timestamp + 0.01 * 60.0),
      u'module_file': u'%s' % promise_file,
      u'module_file_mtime': file_stat.st_mtime,
    }
    self.assertTrue(new_timestamp > timestamp)
    # next run is in future
    self.assertTrue(cache_dict['next_run_after'] > next_run_after)
    self.assertEqual(info_dict, cache_dict)

1561 1562 1563 1564 1565 1566 1567 1568
class TestSlapOSGenericPromise(TestSlapOSPromiseMixin):

  def initialisePromise(self, promise_content="", success=True, timeout=60):
    self.promise_name = 'my_promise.py'
    self.promise_path = os.path.join(self.plugin_dir, self.promise_name)
    self.configureLauncher()
    self.generatePromiseScript(self.promise_name, periodicity=1, content=promise_content, success=success)
    self.writeInit()
Bryton Lacquement's avatar
Bryton Lacquement committed
1569
    self.queue = queue.Queue()
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
    self.promise_config = {
      'log-folder': self.log_dir,
      'partition-folder': self.partition_dir,
      'promise-timeout': timeout,
      'debug': False,
      'check-anomaly': True,
      'master-url': "https://master.url.com",
      'partition-cert': '',
      'partition-key': '',
      'partition-id': self.partition_id,
      'computer-id': self.computer_id,
      'queue': self.queue,
      'path': self.promise_path,
      'name': self.promise_name
    }

1586 1587 1588 1589 1590
  def createPromiseProcess(self, check_anomaly=False, wrap=False):
    return PromiseProcess(
      self.partition_dir,
      self.promise_name,
      self.promise_path,
1591
      logger=logging.getLogger('slapos.test.promise'),
1592 1593 1594 1595 1596
      argument_dict=self.promise_config,
      check_anomaly=check_anomaly,
      wrap=wrap,
    )

1597 1598
  def test_create_simple_promise(self):
    self.initialisePromise()
1599 1600
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1601
    promise = promise_module.RunPromise(self.promise_config)
1602 1603 1604 1605 1606 1607 1608
    self.assertEqual(promise.getPeriodicity(), 1)
    self.assertEqual(promise.getName(), self.promise_name)
    self.assertEqual(promise.getTitle(), 'my_promise')
    self.assertEqual(promise.getPartitionFolder(), self.partition_dir)
    self.assertEqual(promise.getPromiseFile(), self.promise_path)
    self.assertEqual(promise.getLogFolder(), self.log_dir)
    self.assertEqual(promise.getLogFile(), os.path.join(self.log_dir, 'my_promise.log'))
1609 1610

    promise.setPeriodicity(2)
1611
    self.assertEqual(promise.getPeriodicity(), 2)
1612 1613 1614 1615 1616 1617 1618
    with self.assertRaises(ValueError):
      promise.setPeriodicity(0)

    promise.run(check_anomaly=True)
    result = self.queue.get(True, 1)
    self.assertTrue(isinstance(result, PromiseQueueResult))
    self.assertTrue(isinstance(result.item, AnomalyResult))
1619 1620 1621 1622 1623
    self.assertEqual(result.title, 'my_promise')
    self.assertEqual(result.name, self.promise_name)
    self.assertEqual(result.path, os.path.join(self.plugin_dir, self.promise_name))
    self.assertEqual(result.item.message, "success")
    self.assertEqual(result.item.hasFailed(), False)
1624 1625
    self.assertTrue(isinstance(result.item.date, datetime))

1626 1627 1628
  def test_promise_cleanup_plugin_dir(self):
    stale_pyc = os.path.join(self.plugin_dir, 'stale.pyc')
    with open(stale_pyc, 'w') as fh:
1629
      fh.write('')
1630 1631
    stale_pyo = os.path.join(self.plugin_dir, 'stale.pyo')
    with open(stale_pyo, 'w') as fh:
1632
      fh.write('')
1633 1634 1635 1636 1637
    self.initialisePromise()
    self.launcher.run()
    self.assertFalse(os.path.exists(stale_pyc))
    self.assertFalse(os.path.exists(stale_pyo))

1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
  def test_promise_cleanup_output_history(self):
    promise_name = 'dummy.py'
    promise_content = """from zope.interface import implementer
from slapos.grid.promise import interface
from slapos.grid.promise import GenericPromise

@implementer(interface.IPromise)
class RunPromise(GenericPromise):

  def sense(self):
    self.logger.info("success")

  def anomaly(self):
    return self._anomaly()

  def test(self):
    return self._test()
"""

    promise_path = os.path.join(self.plugin_dir, promise_name)
    self.writeFile(promise_path, promise_content)
    self.writeInit()

    # output .slapgrid/promise/result
    # history .slapgrid/promise/history'
    promise_dir = os.path.join(self.partition_dir, '.slapgrid', 'promise')
    result_dir = os.path.join(promise_dir, 'result')
    history_dir = os.path.join(promise_dir, 'history')
    os.makedirs(result_dir)
    os.makedirs(history_dir)

    def createFile(path, name, content=''):
      filepath = os.path.join(path, name)
      with open(filepath, 'w') as fh:
        fh.write(content)
      return filepath

    promise_status_json  = createFile(
      promise_dir, 'promise_status.json',
      '{"stale.py": ["OK", "2020-01-09T08:09:44+0000", '
      '"260ca9dd8a4577fc00b7bd5810298076"]}')

    dummy_result = createFile(result_dir, 'dummy.status.json')
    dummy_history = createFile(history_dir, 'dummy.history.json')
    dummy_history_old = createFile(history_dir, 'dummy.history.old.json')

    stale_result = createFile(result_dir, 'stale.status.json')
    stale_history = createFile(history_dir, 'stale.history.json')
    stale_history_old = createFile(history_dir, 'stale.history.old.json')

    just_result_file = createFile(result_dir, 'doesnotmatch')
    just_history_file = createFile(history_dir, 'doesnotmatch')

    def assertPathExists(path):
      self.assertTrue(os.path.exists(path))

    def assertPathNotExists(path):
      self.assertFalse(os.path.exists(path))

    self.initialisePromise()
    self.launcher.run()

    assertPathExists(dummy_result)
    assertPathExists(dummy_history)
    assertPathExists(dummy_history_old)

    # check that it does not clean up too much
    assertPathExists(just_result_file)
    assertPathExists(just_history_file)

    assertPathNotExists(stale_result)
    assertPathNotExists(stale_history)
    assertPathNotExists(stale_history_old)

    with open(promise_status_json) as fh:
      promise_status = json.load(fh)
    self.assertNotIn('stale.py', promise_status)

1716 1717
  def test_promise_anomaly_disabled(self):
    self.initialisePromise()
1718 1719
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1720 1721 1722 1723 1724 1725
    promise = promise_module.RunPromise(self.promise_config)

    promise.run()
    result = self.queue.get(True, 1)
    self.assertTrue(isinstance(result, PromiseQueueResult))
    self.assertTrue(isinstance(result.item, TestResult))
1726 1727 1728 1729 1730
    self.assertEqual(result.title, 'my_promise')
    self.assertEqual(result.name, self.promise_name)
    self.assertEqual(result.path, os.path.join(self.plugin_dir, self.promise_name))
    self.assertEqual(result.item.message, "success")
    self.assertEqual(result.item.hasFailed(), False)
1731 1732 1733 1734 1735
    self.assertTrue(isinstance(result.item.date, datetime))

  def test_promise_with_raise(self):
    promise_content = "raise ValueError('Bad Promise raised')"
    self.initialisePromise(promise_content)
1736 1737
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1738 1739 1740 1741 1742
    promise = promise_module.RunPromise(self.promise_config)

    # no raise
    promise.run()
    result = self.queue.get(True, 1)
1743 1744 1745 1746
    self.assertEqual(result.title, 'my_promise')
    self.assertEqual(result.name, self.promise_name)
    self.assertEqual(result.item.message, "Bad Promise raised")
    self.assertEqual(result.item.hasFailed(), True)
1747 1748 1749 1750

  def test_promise_no_return(self):
    promise_content = "return"
    self.initialisePromise(promise_content)
1751 1752
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1753 1754 1755 1756 1757
    promise = promise_module.RunPromise(self.promise_config)

    # no raise
    promise.run()
    result = self.queue.get(True, 1)
1758 1759 1760 1761
    self.assertEqual(result.title, 'my_promise')
    self.assertEqual(result.name, self.promise_name)
    self.assertEqual(result.item.message, "No result found!")
    self.assertEqual(result.item.hasFailed(), False)
1762 1763 1764 1765

  def test_promise_resultfromlog(self):
    promise_content = "self.logger.info('Promise is running...')"
    self.initialisePromise(promise_content)
1766 1767
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1768 1769 1770 1771 1772 1773 1774
    promise = promise_module.RunPromise(self.promise_config)

    date = datetime.now()
    promise.sense()
    # get all messages during the latest minute
    latest_message_list = promise.getLastPromiseResultList(result_count=1)
    date = datetime.strptime(date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
1775 1776
    self.assertEqual(len(latest_message_list), 1)
    self.assertEqual(
1777 1778
      latest_message_list[0][0],
      {'date': date, 'status': 'INFO', 'message': 'Promise is running...'})
1779
    self.assertEqual(
1780 1781 1782 1783 1784 1785
      latest_message_list[0][1],
      {'date': date, 'status': 'INFO', 'message': 'success'})

  def test_promise_resultfromlog_error(self):
    promise_content = 'self.logger.error("Promise is running...\\nmessage in new line")'
    self.initialisePromise(promise_content)
1786 1787
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1788 1789 1790 1791 1792 1793 1794
    promise = promise_module.RunPromise(self.promise_config)

    date = datetime.now()
    promise.sense()
    # get all messages during the latest minute
    latest_message_list = promise.getLastPromiseResultList(result_count=1)
    date = datetime.strptime(date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
1795 1796
    self.assertEqual(len(latest_message_list), 1)
    self.assertEqual(
1797 1798 1799
      latest_message_list[0][0],
      {'date': date, 'status': 'ERROR',
       'message': 'Promise is running...\nmessage in new line'})
1800
    self.assertEqual(
1801 1802 1803 1804 1805 1806 1807
      latest_message_list[0][1],
      {'date': date, 'status': 'INFO', 'message': 'success'})

  def test_promise_resultfromlog_no_logfolder(self):
    self.log_dir = None
    promise_content = "self.logger.info('Promise is running...')"
    self.initialisePromise(promise_content)
1808 1809
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1810 1811 1812 1813
    promise = promise_module.RunPromise(self.promise_config)

    date = datetime.now()
    promise.sense()
1814 1815
    self.assertEqual(promise.getLogFolder(), None)
    self.assertEqual(promise.getLogFile(), None)
1816 1817 1818 1819

    # get all messages during the latest minute
    latest_message_list = promise.getLastPromiseResultList(result_count=1)
    date = datetime.strptime(date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
1820 1821
    self.assertEqual(len(latest_message_list), 1)
    self.assertEqual(
1822 1823
      latest_message_list[0][0],
      {'date': date, 'status': 'INFO', 'message': 'Promise is running...'})
1824
    self.assertEqual(
1825 1826 1827 1828 1829
      latest_message_list[0][1],
      {'date': date, 'status': 'INFO', 'message': 'success'})

  def test_promise_resultfromlog_latest_minutes(self):
    self.initialisePromise(timeout=60)
1830 1831
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
    promise = promise_module.RunPromise(self.promise_config)

    # write some random logs
    start_date = datetime.now()
    with open(promise.getLogFile(), 'w') as f:
      for i in range(0, 50):
        transaction_id = '%s-%s' % (int(time.time()), random.randint(100, 999))
        date = start_date - timedelta(minutes=(49 - i))
        date_string = date.strftime('%Y-%m-%d %H:%M:%S')
        line = "%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, i)
        f.write(line)

    latest_message_list = promise.getLastPromiseResultList(
      latest_minute=10,
      result_count=100
    )
    start_date = datetime.strptime(start_date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
    end_date_string = (start_date - timedelta(minutes=9)).strftime('%Y-%m-%d %H:%M:%S')
    end_date = datetime.strptime(end_date_string, '%Y-%m-%d %H:%M:%S')
1851
    self.assertEqual(len(latest_message_list), 10)
1852
    for message in latest_message_list:
1853 1854
      self.assertEqual(len(message), 1)
    self.assertEqual(
1855 1856
      latest_message_list[0][0],
      {'date': start_date, 'status': 'INFO', 'message': 'Promise result 49'})
1857
    self.assertEqual(
1858 1859 1860 1861 1862
      latest_message_list[-1][0],
      {'date': end_date, 'status': 'INFO', 'message': 'Promise result 40'})

  def test_promise_resultfromlog_latest_minutes_multilog(self):
    self.initialisePromise(timeout=60)
1863 1864
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
    promise = promise_module.RunPromise(self.promise_config)

    # write some random logs
    start_date = datetime.now()
    date = start_date
    line_list = []
    j = 0
    for i in range(0, 25):
      transaction_id = '%s-%s' % (int(time.time()), random.randint(100, 999))
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1

    line_list.reverse()
    with open(promise.getLogFile(), 'w') as f:
      f.write('\n'.join(line_list))

    latest_message_list = promise.getLastPromiseResultList(
      latest_minute=10,
      result_count=100
    )

    start_date = datetime.strptime(start_date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
    end_date_string = (start_date - timedelta(seconds=30*19)).strftime('%Y-%m-%d %H:%M:%S')
    end_date = datetime.strptime(end_date_string, '%Y-%m-%d %H:%M:%S')
    # there is 2 result line per minutes
1896
    self.assertEqual(len(latest_message_list), 10)
1897
    for message in latest_message_list:
1898 1899
      self.assertEqual(len(message), 2)
    self.assertEqual(
1900 1901
      latest_message_list[0][1],
      {'date': start_date, 'status': 'INFO', 'message': 'Promise result 0'})
1902
    self.assertEqual(
1903 1904 1905 1906 1907
      latest_message_list[-1][0],
      {'date': end_date, 'status': 'INFO', 'message': 'Promise result 19'})

  def test_promise_resultfromlog_result_count(self):
    self.initialisePromise()
1908 1909
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
    promise = promise_module.RunPromise(self.promise_config)

    # write some random logs
    start_date = datetime.now()
    date = start_date
    line_list = []
    j = 0
    for i in range(0, 25):
      transaction_id = '%s-%s' % (int(time.time()), random.randint(100, 999))
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1

    line_list.reverse()
    with open(promise.getLogFile(), 'w') as f:
      f.write('\n'.join(line_list))

    # result_count = 2 will return 2 log
    # max execution time is 1 min and log is writen every 30 seconds
    latest_message_list = promise.getLastPromiseResultList(result_count=1)

    start_date = datetime.strptime(start_date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
    end_date_string = (start_date - timedelta(seconds=30)).strftime('%Y-%m-%d %H:%M:%S')
    end_date = datetime.strptime(end_date_string, '%Y-%m-%d %H:%M:%S')
    # there is 2 result line per minutes
1940 1941
    self.assertEqual(len(latest_message_list), 1)
    self.assertEqual(
1942 1943
      latest_message_list[0][0],
      {'date': end_date, 'status': 'INFO', 'message': 'Promise result 1'})
1944
    self.assertEqual(
1945 1946 1947 1948 1949
      latest_message_list[0][1],
      {'date': start_date, 'status': 'INFO', 'message': 'Promise result 0'})

  def test_promise_resultfromlog_result_count_many(self):
    self.initialisePromise()
1950 1951
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
    promise = promise_module.RunPromise(self.promise_config)

    # write some random logs
    start_date = datetime.now()
    date = start_date
    line_list = []
    j = 0
    for i in range(0, 25):
      transaction_id = '%s-%s' % (int(time.time()), random.randint(100, 999))
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1
      date_string = date.strftime('%Y-%m-%d %H:%M:%S')
      line_list.append("%s - INFO - %s - Promise result %s\n" % (date_string, transaction_id, j))
      date = date - timedelta(seconds=30)
      j += 1

    line_list.reverse()
    with open(promise.getLogFile(), 'w') as f:
      f.write('\n'.join(line_list))

    # result_count = 2 will return 4 log
    # max execution time is 1 min and log is writen every 30 seconds
    latest_message_list = promise.getLastPromiseResultList(result_count=2)

    start_date = datetime.strptime(start_date.strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S')
    end_date_string = (start_date - timedelta(seconds=30*3)).strftime('%Y-%m-%d %H:%M:%S')
    end_date = datetime.strptime(end_date_string, '%Y-%m-%d %H:%M:%S')
    # there is 2 result line per minutes
1982
    self.assertEqual(len(latest_message_list), 2)
1983
    for message in latest_message_list:
1984 1985
      self.assertEqual(len(message), 2)
    self.assertEqual(
1986 1987
      latest_message_list[0][1],
      {'date': start_date, 'status': 'INFO', 'message': 'Promise result 0'})
1988
    self.assertEqual(
1989 1990 1991 1992 1993
      latest_message_list[-1][0],
      {'date': end_date, 'status': 'INFO', 'message': 'Promise result 3'})

    latest_message_list = promise.getLastPromiseResultList(result_count=100)
    # all results
1994
    self.assertEqual(len(latest_message_list), 25)
1995 1996 1997 1998

  def test_promise_defaulttest(self):
    promise_content = 'self.logger.info("Promise is running...\\nmessage in new line")'
    self.initialisePromise(promise_content)
1999 2000
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2001 2002 2003 2004 2005 2006
    promise = promise_module.RunPromise(self.promise_config)

    promise.sense()

    result = promise._test(result_count=1, failure_amount=1)
    self.assertTrue(isinstance(result, TestResult))
2007 2008
    self.assertEqual(result.message, 'Promise is running...\nmessage in new line\nsuccess')
    self.assertEqual(result.hasFailed(), False)
2009 2010 2011

  def test_promise_defaulttest_failure(self):
    self.initialisePromise(success=False)
2012 2013
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2014 2015 2016 2017 2018 2019
    promise = promise_module.RunPromise(self.promise_config)

    promise.sense()

    result = promise._test(result_count=1, failure_amount=1)
    self.assertTrue(isinstance(result, TestResult))
2020 2021
    self.assertEqual(result.message, 'failed')
    self.assertEqual(result.hasFailed(), True)
2022 2023 2024

  def test_promise_defaulttest_error_if_two_fail(self):
    self.initialisePromise(success=False, timeout=1)
2025 2026
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2027 2028 2029 2030 2031 2032 2033
    promise = promise_module.RunPromise(self.promise_config)

    promise.sense()

    # fail if 2 errors found
    result = promise._test(result_count=2, failure_amount=2)
    self.assertTrue(isinstance(result, TestResult))
2034 2035
    self.assertEqual(result.message, 'failed')
    self.assertEqual(result.hasFailed(), False)
2036 2037

    self.initialisePromise(success=False, timeout=1)
2038 2039
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2040 2041 2042
    promise = promise_module.RunPromise(self.promise_config)
    promise.sense()
    result = promise._test(result_count=2, failure_amount=2)
2043 2044
    self.assertEqual(result.message, 'failed')
    self.assertEqual(result.hasFailed(), True)
2045 2046 2047

    # will continue to fail
    self.initialisePromise(success=False, timeout=1)
2048 2049
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2050 2051 2052
    promise = promise_module.RunPromise(self.promise_config)
    promise.sense()
    result = promise._test(result_count=2, failure_amount=2)
2053 2054
    self.assertEqual(result.message, 'failed')
    self.assertEqual(result.hasFailed(), True)
2055 2056 2057 2058

  def test_promise_defaulttest_anomaly(self):
    promise_content = 'self.logger.info("Promise is running...\\nmessage in new line")'
    self.initialisePromise(promise_content)
2059 2060
    promise_process = self.createPromiseProcess()
    promise_module = promise_process._loadPromiseModule()
2061 2062 2063 2064 2065 2066
    promise = promise_module.RunPromise(self.promise_config)

    promise.sense()

    result = promise._anomaly(result_count=1, failure_amount=1)
    self.assertTrue(isinstance(result, AnomalyResult))
2067 2068
    self.assertEqual(result.message, 'Promise is running...\nmessage in new line\nsuccess')
    self.assertEqual(result.hasFailed(), False)
2069 2070 2071 2072


if __name__ == '__main__':
  unittest.main()