/usr/share/pyshared/insanity/test.py is in python-insanity 0.0+git20110920.4750a8e8-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 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 339 340 341 342 343 344 345 346 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 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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 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 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 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 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 | # GStreamer QA system
#
# test.py
#
# Copyright (c) 2007, Edward Hervey <bilboed@bilboed.com>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser 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.
"""
Base Test Classes
"""
import os
import time
from insanity.log import error, warning, debug, info, exception
import insanity.utils as utils
import gobject
# Class tree
#
# Test
# |
# +--- Scenario
# |
# +--- DBusTest
# |
# +--- PythonDBusTest
# |
# +--- GStreamerTest
# |
# +--- CmdLineTest
class Test(gobject.GObject):
"""
Runs a series of commands
@ivar uuid: unique identifier for the test
"""
SKIPPED = None
FAILURE = 0
SUCCESS = 1
EXPECTED_FAILURE = 2
__test_name__ = "test-base-class"
"""
Name of the test
This name should be unique amongst all tests, it is
used as an identifier for this test.
"""
__test_description__ = """Base class for tests"""
"""
One-liner description of the test
"""
__test_full_description__ = __test_description__
"""
Extended description of the test
By default, the same value as __test_description__ will be
used, but it can be useful for tests that can not summarize
in one line their purpose and usage.
"""
__test_arguments__ = {
"instance-name": ("Name assigned by parent.", "",
"Used to identify similar subtests within a scenario."),
"expected-failures": ("List of dicts documenting expected failures.",
[],
"""Must be of the form:
[{
"arguments": {argname: [broken_value, ...], ...},
"results": {checkitemname: ['0' or 'None'], ...},
}, ...],
If the test's arguments all match values in arguments, and the
result of the check matches one in "results", mark the failure as
expected."""),
}
"""
Dictionnary of arguments this test can take.
key : name of the argument
value : tuple of :
* short description of the argument
* default value used
* long description of the argument (if None, same as short description)
"""
__test_checklist__ = {
"test-started": "The test started",
"no-timeout": "The test didn't timeout",
"no-unexpected-failures": "All failed checks were expected.",
}
"""
Dictionnary of check items this test will validate.
For each item, the test will try to validate them as
being succesfull (True) or not (False).
key : name of the check item
value :
* short description of the check item
"""
__test_likely_errors__ = {}
"""
Dictionary of likely error causes for check items for which
a likely error cause can be assumed.
key : name of the check item
value : short description of the likely error cause
"""
__test_timeout__ = 15
"""
Allowed duration for the test to run (in seconds).
"""
__test_extra_infos__ = {
"test-setup-duration" :
"How long it took to setup the test (in milliseconds) for asynchronous tests",
"test-total-duration" :
"How long it took to run the entire test (in milliseconds)"
}
"""
Dictionnary of extra information this test can produce.
"""
__test_output_files__ = { }
"""
Dictionnary of output files this test can produce
key : short name of the output file
value : description of the contents of the output file
Temporary names will be automatically created at initialization for use by
subtests, or can be overridden by setting specific names as the 'outputfiles'
__init__() argument.
"""
# Set to True if your setUp doesn't happen synchronously
__async_setup__ = False
"""
Indicates if this test starts up asynchronously
"""
# Subclasses need to call ready within that delay (in seconds)
__async_setup_timeout__ = 10
"""
Allowed duration for the test to start up (in seconds)
"""
# Set to False if you test() method returns immediatly
__async_test__ = True
"""
Indicates if this test runs asynchronously
"""
__gsignals__ = {
"start" : (gobject.SIGNAL_RUN_LAST,
gobject.TYPE_NONE,
()),
"done" : (gobject.SIGNAL_RUN_LAST,
gobject.TYPE_NONE,
()),
"check" : (gobject.SIGNAL_RUN_LAST,
gobject.TYPE_NONE,
(gobject.TYPE_PYOBJECT,
gobject.TYPE_PYOBJECT)),
"extra-info" : (gobject.SIGNAL_RUN_LAST,
gobject.TYPE_NONE,
(gobject.TYPE_PYOBJECT,
gobject.TYPE_PYOBJECT))
}
def __init__(self, testrun=None, uuid=None, timeout=None,
asynctimeout=None,
**kwargs):
"""
@type testrun: L{TestRun}
"""
gobject.GObject.__init__(self)
self._timeout = timeout or self.__test_timeout__
self._asynctimeout = asynctimeout or self.__async_setup_timeout__
self._running = False
self.arguments = utils.unicode_dict(kwargs)
self._stopping = False
# list of actual check items
self._checklist = []
# dictionnary of possible values
self._possiblechecklist = {}
# populate checklist with all possible checkitems
# initialize checklist to False
self._populateChecklist()
self._extrainfo = {}
self._testrun = testrun
if uuid == None:
self.uuid = utils.acquire_uuid()
else:
self.uuid = uuid
self.arguments["uuid"] = self.uuid
self._outputfiles = kwargs.get("outputfiles", {})
# creating default file names
if self._testrun:
for ofname in self.getFullOutputFilesList().iterkeys():
if not ofname in self._outputfiles:
ofd, opath = self._testrun.get_temp_file(nameid=ofname)
debug("created temp file name '%s' for outputfile '%s' [%s]",
opath, ofname, self.uuid)
self._outputfiles[ofname] = opath
os.close(ofd)
self._asynctimeoutid = 0
self._testtimeoutid = 0
# time at which events started
self._asyncstarttime = 0
self._teststarttime = 0
# time at which the timeouts should occur,
# we store this in order to modify timeouts while
# running
self._asynctimeouttime = 0
self._testtimeouttime = 0
# list of (monitor, monitorargs)
self._monitors = []
self._monitorinstances = []
# see __test_arguments__ for details.
self._expected_failure_patterns = kwargs.get('expected-failures', [])
# dict containing (checkitem, True) for every expected failure that happened
self._expected_failures = {}
# dict containing (checkitem, explanation) for every failure that has
# an explanation
self._error_explanations = {}
@classmethod
def get_file(cls):
"""
Returns the absolute path location of this test.
This method MUST be copied in all subclasses that are not
in the same module as its parent !
"""
import os.path
return os.path.abspath(cls.__file__)
def __repr__(self):
if self.uuid:
return "< %s uuid:%s >" % (self.__class__.__name__, self.uuid)
return "< %s id:%r >" % (self.__class__.__name__, id(self))
def _populateChecklist(self):
""" fill the instance checklist with default values """
ckl = self.getFullCheckList()
for key in ckl.keys():
self._possiblechecklist[key] = False
def _asyncSetupTimeoutCb(self):
debug("async setup timeout for %r", self)
now = time.time()
if now < self._asynctimeouttime:
debug("async setup timeout must have changed in the meantime")
diff = int((self._asynctimeouttime - now) * 1000)
self._asynctimeoutid = gobject.timeout_add(diff, self._asyncSetupTimeoutCb)
return False
self._asynctimeoutid = 0
self.stop()
return False
def _testTimeoutCb(self):
debug("timeout for %r", self)
now = time.time()
if now < self._testtimeouttime:
debug("timeout must have changed in the meantime")
diff = int((self._testtimeouttime - now) * 1000)
self._testtimeoutid = gobject.timeout_add(diff, self._testTimeoutCb)
return False
self._testtimeoutid = 0
self.stop()
return False
def run(self):
# 1. setUp the test
self._teststarttime = time.time()
if not self.setUp():
error("Something went wrong during setup !")
self.stop()
return False
if self.__async_setup__:
# the subclass will call start() on his own
# put in a timeout check
self._asynctimeouttime = time.time() + self._asynctimeout
self._asynctimeoutid = gobject.timeout_add(self._asynctimeout * 1000,
self._asyncSetupTimeoutCb)
return True
# 2. Start it
self.start()
if not self.__async_test__:
self.stop()
return True
def setUp(self):
"""
Prepare the test, initialize variables, etc...
Return True if you setUp didn't encounter any issues, else
return False.
If you implement this method, you need to chain up to the
parent class' setUp() at the BEGINNING of your function without
forgetting to take into account the return value.
If your test does its setup asynchronously, set the
__async_setup__ property of your class to True
"""
# call monitors setup
if not self._setUpMonitors():
return False
return True
def _setUpMonitors(self):
for monitor, monitorarg in self._monitors:
if monitorarg == None:
monitorarg = {}
instance = monitor(self._testrun, self, **monitorarg)
if not instance.setUp():
return False
self._monitorinstances.append(instance)
return True
def tearDown(self):
"""
Clear test
If you implement this method, you need to chain up to the
parent class' tearDown() at the END of your method.
Your teardown MUST happen in a synchronous fashion.
"""
if self._asynctimeoutid:
gobject.source_remove(self._asynctimeoutid)
self._asynctimeoutid = 0
if self._testtimeoutid:
gobject.source_remove(self._testtimeoutid)
self._testtimeoutid = 0
for ofname, fname in list(self._outputfiles.iteritems()):
if os.path.exists(fname):
if not os.path.getsize(fname):
debug("removing empty file from outputfiles dictionnary")
os.remove(fname)
del self._outputfiles[ofname]
else:
debug("removing unexistent file from outputfiles dictionnary")
del self._outputfiles[ofname]
def stop(self):
"""
Stop the test
Can be called by both the test itself AND external elements
"""
if self._stopping:
warning("we were already stopping !!!")
return
info("STOPPING %r" % self)
self._stopping = True
stoptime = time.time()
# if we still have the timeoutid, we didn't timeout
notimeout = False
if self._testtimeoutid:
notimeout = True
self.validateStep("no-timeout", notimeout)
self.tearDown()
if self._teststarttime:
debug("stoptime:%r , teststarttime:%r",
stoptime, self._teststarttime)
self.extraInfo("test-total-duration",
int((stoptime - self._teststarttime) * 1000))
for instance in self._monitorinstances:
instance.tearDown()
self.emit("done")
def start(self):
"""
Starts the test.
Only called by tests that implement asynchronous setUp
"""
# if we were doing async setup, remove asyncsetup timeout
if self.__async_setup__:
if self._asynctimeoutid:
gobject.source_remove(self._asynctimeoutid)
self._asynctimeoutid = 0
curtime = time.time()
self.extraInfo("test-setup-duration",
int((curtime - self._teststarttime) * 1000))
self._running = True
self.emit("start")
self.validateStep("test-started")
# start timeout for test !
self._testtimeouttime = time.time() + self._timeout
self._testtimeoutid = gobject.timeout_add(self._timeout * 1000,
self._testTimeoutCb)
self.test()
def test(self):
"""
This method will be called at the beginning of the test
"""
raise NotImplementedError
## Methods for tests to return information
def validateStep(self, checkitem, validated=True):
"""
Validate a step in the checklist.
checkitem is one of the keys of __test_checklist__
validated is a boolean indicating whether that step should be
validated or not.
Called by the test itself
"""
info("step %s for item %r : %r" % (checkitem, self, validated))
# check for valid checkitem
if not checkitem in self._possiblechecklist:
return
# check to see if we don't already have it
if checkitem in dict(self._checklist):
return
self._checklist.append((checkitem, bool(validated)))
if not validated:
if self.isExpectedFailure(checkitem, self._extrainfo):
self._expected_failures[checkitem] = True
explanation = self.processFailure(checkitem, self._extrainfo)
if explanation is not None:
self._error_explanations[checkitem] = explanation
#self._checklist[checkitem] = True
self.emit("check", checkitem, validated)
def isExpectedFailure(self, checkitem, extra_info):
return self.isExpectedResult(checkitem, self.FAILURE, extra_info)
def isExpectedResult(self, checkitem, result, extra_info):
for pattern in self._expected_failure_patterns:
if checkitem not in pattern["results"]:
continue
if str(result) not in pattern["results"][checkitem]:
if "None" in pattern["results"][checkitem]:
debug("This rule only matches skipped checks.")
elif "0" in pattern["results"][checkitem]:
debug("This rule only matches failed checks.")
else:
warning("This rule doesn't match any checks: %s", pattern)
continue
if "arguments" in pattern:
for k, v in pattern["arguments"].items():
if k not in self.arguments:
break
if self.arguments[k] not in v:
break
else:
return True
return False
def extraInfo(self, key, value):
"""
Give extra information obtained while running the tests.
If key was already given, the new value will override the value
previously given for the same key.
Called by the test itself
"""
info("uuid:%s, key:%s, value:%r", self.uuid, key, value)
self._extrainfo[key] = value
self.emit("extra-info", key, value)
## Getters/Setters
@classmethod
def getFullCheckList(cls):
"""
Returns the full test checklist. This is used to know all the
possible check items for this instance, along with their description.
"""
dc = {}
for cl in cls.mro():
if "__test_checklist__" in cl.__dict__:
dc.update(cl.__test_checklist__)
if cl == Test:
break
return dc
@classmethod
def getFullArgumentList(cls):
"""
Returns the full list of arguments with descriptions.
The format of the returned argument dictionnary is:
key : argument name
value : tuple of :
* short description
* default value
* extended description (Can be None)
"""
dc = {}
for cl in cls.mro():
if "__test_arguments__" in cls.__dict__:
dc.update(cl.__test_arguments__)
if cl == Test:
break
return dc
@classmethod
def getFullExtraInfoList(cls):
"""
Returns the full list of extra info with descriptions.
"""
dc = {}
for cl in cls.mro():
if "__test_extra_infos__" in cls.__dict__:
dc.update(cl.__test_extra_infos__)
if cl == Test:
break
return dc
@classmethod
def getFullOutputFilesList(cls):
"""
Returns the full list of output files with descriptions.
"""
dc = {}
for cl in cls.mro():
if "__test_output_files__" in cls.__dict__:
dc.update(cl.__test_output_files__)
if cl == Test:
break
return dc
def getCheckList(self):
"""
Returns the instance checklist as a list of tuples of:
* checkitem name
* value indicating whether the success of that step
That value can be one of: SKIPPED, SUCCESS, FAILURE, EXPECTED_FAILURE
"""
allk = self.getFullCheckList().keys()
unexpected_failures = []
def to_enum(key, val):
if val:
return self.SUCCESS
elif self._expected_failures.get(key, False):
return self.EXPECTED_FAILURE
else:
unexpected_failures.append(key)
return self.FAILURE
d = dict((k, to_enum(k, v)) for k, v in self._checklist)
d["no-unexpected-failures"] = 1
for k in allk:
if k not in d:
if self.isExpectedResult(k, self.SKIPPED, self._extrainfo):
d[k] = self.EXPECTED_FAILURE
else:
unexpected_failures.append(k)
d[k] = self.SKIPPED
if unexpected_failures:
warning("The following tests failed unexpectedly: %s",
unexpected_failures)
d["no-unexpected-failures"] = 0
return d.items()
def getArguments(self):
"""
Returns the list of arguments for the given test
"""
validkeys = self.getFullArgumentList()
# Hide expected-failures from the storage backend.
validkeys.pop("expected-failures", [])
res = {}
for key in self.arguments.iterkeys():
if key in validkeys:
res[key] = self.arguments[key]
return res
def getSuccessPercentage(self):
"""
Returns the success rate of this instance as a float
"""
ckl = self.getCheckList()
nbsteps = len(self._possiblechecklist)
nbsucc = len([step for step, val in ckl if val == True])
return (100.0 * nbsucc) / nbsteps
def getExtraInfo(self):
"""
Returns the extra-information dictionnary
"""
return self._extrainfo
def getOutputFiles(self):
"""
Returns the output files generated by the test
"""
return self._outputfiles
def getErrorExplanations(self):
"""
Returns dict of error explanations for failed check items. Only
the failed items that have some explanation are present in the
dict.
key : name of the failed check item
value : error explanation
"""
return self._error_explanations
def getTimeout(self):
"""
Returns the currently configured timeout
"""
return self._timeout
def setTimeout(self, timeout):
"""
Set the timeout period for running this test in seconds.
Returns True if the timeout could be modified, else False.
"""
debug("timeout : %d", timeout)
if self._testtimeoutid:
debug("updating timeout/timeouttime")
self._testtimeouttime = self._testtimeouttime - self._timeout + timeout
self._timeout = timeout
return True
def getAsyncSetupTimeout(self):
"""
Returns the currently configured async setup timeout
"""
return self._asynctimeout
def setAsyncSetupTimeout(self, timeout):
"""
Set the timeout period for asynchronous test to startup in
seconds.
Returns True if the timeout could be modified, else False.
"""
debug("timeout : %d", timeout)
if self._asynctimeoutid:
debug("updating timeout/timeouttime")
self._asynctimeouttime -= (self._asynctimeout - timeout)
self._asynctimeout = timeout
return True
def addMonitor(self, monitor, monitorargs=None):
"""
Add a monitor to this test instance.
Checks will be done to ensure that the monitor can be applied
on this instance.
Returns True if the monitor was applied succesfully.
"""
debug("monitor:%r, args:%r", monitor, monitorargs)
# check if monitor is valid
if not isinstance(self, monitor.__applies_on__):
warning("The given monitor cannot be applied on this test")
return False
self._monitors.append((monitor, monitorargs))
def processFailure(self, checkitem, extra_info):
"""
Process the failure and return a human-readable description
of why it happened (string).
By default, returns the likely error explanation from
__test_checklist_errors__. Test subclasses can override
it to provide detailed processing.
Returns None if no explanation is available.
"""
return self.__test_likely_errors__.get(checkitem, None)
# For compatibility:
from insanity.dbustest import DBusTest, PythonDBusTest, CmdLineTest
from insanity.gstreamertest import GStreamerTestBase as GStreamerTest
|