/usr/share/pyshared/qm/test/database.py is in qmtest 2.4.1-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 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 | ########################################################################
#
# File: database.py
# Author: Mark Mitchell
# Date: 2001-10-05
#
# Contents:
# QMTest database class.
#
# Copyright (c) 2001, 2002, 2003 by CodeSourcery, LLC. All rights reserved.
#
# For license terms see the file COPYING.
#
########################################################################
########################################################################
# imports
########################################################################
import os.path
import qm
from qm.common import *
import qm.extension
import qm.fields
from qm.label import *
from qm.test.base import *
from qm.test.directory_suite import DirectorySuite
from qm.test.runnable import Runnable
from qm.test.resource import Resource
from qm.test.suite import Suite
from qm.test.test import Test
########################################################################
# Variables
########################################################################
__the_database = None
"""The global 'Database' object."""
__the_db_path = '.'
"""The path to the database."""
########################################################################
# Classes
########################################################################
class ItemDescriptor:
"""An 'ItemDescriptor' describes a test, resource, or similar entity.
Some 'Database' operations return an instance of a class derived
from 'ItemDescriptor', rather than the object described. For
example, 'Database.GetTest' returns a 'TestDescriptor', not a
'Test'. This additional indirection is an optimization; the
creation of the actual 'Test' object may be relatively expensive,
and in many cases all that is needed is information that can be
gleaned from the descriptor."""
def __init__(self,
database,
instance_id,
class_name = None,
arguments = None,
item = None):
"""Construct an 'ItemDescriptor'.
'database' -- The 'Database' object in which this entity is
located.
'instance_id' -- The label for this entity.
'class_name' -- The name of the extension class for the entity.
For example, for a 'TestDescriptor', the 'class_name' is the
name of the test class. Omit this argument if 'item' is provided.
'arguments' -- A dictionary mapping argument names to argument
values. These arguments will be provided to the extension class
when the entity is constructed. Omit this argument if 'item' is
provided.
'item' -- The item class for this item instance."""
self.__database = database
self.__id = instance_id
assert(not item or not class_name)
self.__class_name = class_name
self.__arguments = arguments
self._item = item
def GetDatabase(self):
"""Return the 'Database' containing this entity.
returns -- The 'Database' object in which this entity is
located."""
return self.__database
def GetClassName(self):
"""Return the class name of the entity.
returns -- The name of the extension class for the entity. For
example, for a 'TestDescriptor', this method returns the name of
the test class."""
if self._item:
return self._item.GetClassName()
else:
return self.__class_name
def GetClass(self):
"""Return the class of the entity.
returns -- The Python class object for the entity. For example,
for a 'TestDescriptor', this method returns the test class."""
raise NotImplementedError
def GetClassArguments(self):
"""Return the arguments specified by the test class.
returns -- A list of 'Field' objects containing all the
arguments in the class hierarchy.
Derived classes should not override this method."""
return qm.extension.get_class_arguments(self.GetClass())
def GetArguments(self):
"""Return the entity arguments.
returns -- A dictionary mapping argument names to argument
values. These arguments will be provided to the extension class
when the entity is constructed."""
if self._item:
return self._item.GetExplicitArguments()
else:
return self.__arguments
def GetId(self):
"""Return the label for this entity.
returns -- The label for this entity."""
return self.__id
def GetItem(self):
"""Return the entity.
returns -- An instance of the class returned by 'GetClass'."""
if not self._item:
extras = { Runnable.EXTRA_ID : self.GetId(),
Runnable.EXTRA_DATABASE : self.GetDatabase() }
self._item = self.GetClass()(self.GetArguments(), **extras)
return self._item
def GetResources(self):
"""Return the resources required by this item.
returns -- A sequence of resource names. Each name indicates a
resource that must be available to this item."""
return self.GetArguments().get(Runnable.RESOURCE_FIELD_ID, [])
# Helper functions.
def _Execute(self, context, result, method):
"""Execute the entity.
'context' -- The 'Context' in which the test should be executed,
or 'None' if the 'method' does not take a 'Context' argument.
'result' -- The 'Result' object corresponding to this execution.
'method' -- The method name of the method on the entity that
should be invoked to perform the execution."""
# Get the item.
item = self.GetItem()
methobj = getattr(item, method)
# Execute the indicated method.
if context is not None:
methobj(context, result)
else:
methobj(result)
class TestDescriptor(ItemDescriptor):
"""A test instance."""
def __init__(self,
database,
test_id,
test_class_name = None,
arguments = None,
test = None):
"""Create a new test instance.
'database' -- The 'Database' containing this test.
'test_id' -- The test ID.
'test_class_name' -- The name of the test class of which this is
an instance. Omit this argument if 'test' is provided.
'arguments' -- This test's arguments to the test class.
Omit this argument if 'test' is provided.
'test' -- The test class of which this is an instance."""
# Initialize the base class.
ItemDescriptor.__init__(self, database,
test_id, test_class_name, arguments,
test)
self.__prerequisites = {}
for p, o in \
self.GetArguments().get(Test.PREREQUISITES_FIELD_ID, []):
self.__prerequisites[p] = o
def GetClass(self):
"""Return the class of the entity.
returns -- The Python class object for the entity. For example,
for a 'TestDescriptor', this method returns the test class."""
if self._item: return type(self._item)
return get_extension_class(self.GetClassName(), 'test',
self.GetDatabase())
def GetTest(self):
"""Return the 'Test' object described by this descriptor."""
return self.GetItem()
def GetPrerequisites(self):
"""Return a map from prerequisite test IDs to required outcomes."""
return self.__prerequisites
def GetTargetGroup(self):
"""Returns the pattern for the targets that can run this test.
returns -- A regular expression (represented as a string) that
indicates the targets on which this test can be run. If the
pattern matches a particular group name, the test can be run
on targets in that group."""
return self.GetArguments().get("target_group", ".*")
def Run(self, context, result):
"""Execute this test.
'context' -- The 'Context' in which the test should be executed.
'result' -- The 'Result' object for this test."""
self._Execute(context, result, "Run")
class ResourceDescriptor(ItemDescriptor):
"""A resource instance."""
def __init__(self,
database,
resource_id,
resource_class_name = None,
arguments = None,
resource = None):
"""Create a new resource instance.
'database' -- The 'Database' containing this resource.
'resource_id' -- The resource ID.
'resource_class_name' -- The name of the resource class of which
this is an instance. Omit this argument if 'resource' is provided.
'arguments' -- This resource's arguments to the resource class.
Omit this argument if 'resource' is provided.
'resource' -- The resource class of which this is an instance."""
# Initialize the base class.
ItemDescriptor.__init__(self, database, resource_id,
resource_class_name, arguments,
resource)
def GetClass(self):
"""Return the class of the entity.
returns -- The Python class object for the entity. For example,
for a 'TestDescriptor', this method returns the test class."""
if self._item: return type(self._item)
return get_extension_class(self.GetClassName(), 'resource',
self.GetDatabase())
def GetResource(self):
"""Return the 'Resource' object described by this descriptor."""
return self.GetItem()
def SetUp(self, context, result):
"""Set up the resource.
'context' -- The 'Context' in which the resource should be executed.
'result' -- The 'Result' object for this resource."""
self._Execute(context, result, "SetUp")
def CleanUp(self, result):
"""Clean up the resource.
'result' -- The 'Result' object for this resource."""
self._Execute(None, result, "CleanUp")
class DatabaseError(QMException):
"""An exception relating to a 'Database'.
All exceptions raised directly by 'Database', or its derived
classes, will be instances of 'DatabaseError', or a class derived
from 'DatabaseError'.
If QMTest catches the exception, it will treat the string
representation of the exception as an error message to be formatted
for the user."""
class NoSuchItemError(DatabaseError):
"""An exception indicating that a particular item could not be found."""
def __init__(self, kind, item_id):
self.kind = kind
self.item_id = item_id
def __str__(self):
"""Return a string describing this exception."""
return qm.message("no such item",
kind = self.kind,
item_id = self.item_id)
class NoSuchTestError(NoSuchItemError):
"""The specified test does not exist."""
def __init__(self, test_id):
"""Construct a new 'NoSuchTestError'
'test_id' -- The name of the test that does not exist."""
NoSuchItemError.__init__(self, Database.TEST, test_id)
class NoSuchSuiteError(NoSuchItemError):
"""The specified suite does not exist."""
def __init__(self, suite_id):
"""Construct a new 'NoSuchSuiteError'
'suite_id' -- The name of the suite that does not exist."""
NoSuchItemError.__init__(self, Database.SUITE, suite_id)
class NoSuchResourceError(NoSuchItemError):
"""The specified resource does not exist."""
def __init__(self, resource_id):
"""Construct a new 'NoSuchResourceError'
'resource_id' -- The name of the resource that does not exist."""
NoSuchItemError.__init__(self, Database.RESOURCE, resource_id)
class Database(qm.extension.Extension):
"""A 'Database' stores tests, testsuites, and resources.
A 'Database' has two primary functions:
1. Test storage and retrieval.
Every test has a unique name, called a "test id". When a new
test is created, the 'Database' is responsible for writing that
test to permanent storage. Later, QMTest will request the test
by providing the database with the test id. The database must
retrieve the test from permanent storage.
QMTest does not put any restrictions on *how* tests are stored.
The default database implementation uses XML to store tests,
but any storage format will do.
2. Test enumeration.
The 'Database' can tell QMTest what tests are stored in the
database. QMTest uses this information in its graphical user
interface to show the user what tests exist.
A 'Database' stores testsuites and resources in addition to tests.
The names for tests, testsuites, and resources are all "labels". A
label is a special kind of string that is designed to be easily
convertible to a file name. For more information, see the
'qm.label' module. The namespaces for tests, testsuites, and
resources are all distinct. For example, it is OK to have a test
with the same name as a testsuite.
Every 'Database' is associated with a particular directory on the
local machine. In most cases, the 'Database' will store all the
files it needs within this directory.
Every 'Database' has an associated 'AttachmentStore'. An
'AttachmentStore' is responsible for storing the attachments
associated with tests. See the module 'qm.attachment' for more
information about 'AttachmentStore'.
'Database' is an abstract class.
You can extend QMTest by providing your own database implementation.
One reason to do this is that you may want to store tests in a
format different from the XML format that QMTest uses by default.
For example, if you are testing a compiler, you might want to
represent each test as a source file. Or, if you are testing a
SQL database, you might want to represent each test as two files:
one containing SQL commands to run the test, and one containing
the output you expect.
Another reason to provide your own database implementation is that
you might want to store tests on a remote location. For example,
suppose you wanted to allow multiple users to access the same
central test database. You could create a test database that
created and retrieved tests by communicating with the central
server.
To create your own database implementation, you must create a Python
class derived (directly or indirectly) from 'Database'. The
documentation for each method of 'Database' indicates whether you
must override it in your database implementation. Some methods may
be overridden, but do not need to be. You might want to override
such a method to provide a more efficient implementation, but QMTest
will work fine if you just use the default version.
If QMTest calls a method on a database and that method raises an
exception that is not caught within the method itself, QMTest will
catch the exception and continue processing. Therefore, methods
here only have to handle exceptions themselves if that is necessary
to maintain the integrity of the database.
A single 'Database' may be accessed by multiple threads
simultaneously. Therefore, you must take appropriate steps to
ensure thread-safe access to shared data."""
arguments = [
qm.fields.TextField(
name = "label_class",
title = "Label Class",
description = """The name of the label class used by this database.
The label class is used to separate names of entities used
by the database into directories and basenames.""",
default_value = "python_label.PythonLabel"
),
qm.fields.BooleanField(
name = "modifiable",
title = "Modifiable?",
description = """Whether or not the database can be modified.
If true, changes (such as the addition or removal of tests,
resources, or suites) can be made to the test database.
If false, tests can be viewed and run, but not modified.""",
default_value = "true")
]
RESOURCE = "resource"
SUITE = "suite"
TEST = "test"
ITEM_KINDS = [RESOURCE, SUITE, TEST]
"""The kinds of items that can be stored in a 'Database'."""
_item_exceptions = {
RESOURCE : NoSuchResourceError,
SUITE : NoSuchSuiteError,
TEST : NoSuchTestError
}
"""The exceptions to be raised when a particular item cannot be found.
This map is indexed by the 'ITEM_KINDS'; the value indicates the
exception class to be used when the indicated kind cannot be found."""
_is_generic_database = False
"""True if this database implements 'GetExtension' as a primitive.
Databases should implement 'GetExtension' and then override
'_is_generic_database', setting it to 'True'. However, legacy
databases implemented 'GetTest', 'GetResource', and 'GetSuite' as
primivites. These legacy databases should not override
'_generic_database'."""
kind = "database"
"""The 'Extension' kind."""
def __init__(self, path, arguments = None, **args):
"""Construct a 'Database'.
'path' -- A string containing the absolute path to the directory
containing the database.
'arguments' -- A dictionary mapping attribute names to values.
The use of this parameter is deprecated. Use keyword arguments instead.
Derived classes must call this method from their own '__init__'
methods. Every derived class must have an '__init__' method that
takes the path to the directory containing the database as its
only argument. The path provided to the derived class '__init__'
function will always be an absolute path."""
if arguments: args.update(arguments)
qm.extension.Extension.__init__(self, **args)
# The path given must be an absolute path.
assert os.path.isabs(path)
self.__path = path
# Translate the label class name into an actual Python class.
self.__label_class \
= get_extension_class(self.label_class, "label", self)
# Methods that deal with labels.
def IsValidLabel(self, label, is_component = 1):
"""Return true if 'label' is valid.
'label' -- A string that is being considered as a label.
'is_component' -- True if the string being tested is just a
single component of a label path.
returns -- True if 'label' is a valid name for entities in this
database."""
return self.__label_class("").IsValid(label, is_component)
def JoinLabels(self, *labels):
"""Join the 'labels' together.
'labels' -- A sequence of strings corresponding to label
components.
returns -- A string containing the complete label."""
if not labels:
return ""
return str(apply(self.__label_class(labels[0]).Join,
labels[1:]))
def SplitLabel(self, label):
"""Split the label into a pair '(directory, basename)'.
returns -- A pair of strings '(directory, basename)'."""
return map(str, self.__label_class(label).Split())
def SplitLabelLeft(self, label):
"""Split the label into a pair '(parent, subpath)'.
This is the same operation as SplitLabel, except the split
occurs at the leftmost separator, not the rightmost, and a
single-component label comes back in the parent slot.
returns -- A pair of strings '(parent, subpath)'."""
return map(str, self.__label_class(label).SplitLeft())
def GetLabelComponents(self, label):
"""Return all of the component directories of 'label'.
'label' -- A string naming an entity in the database.
returns -- A list of strings. The first string is the first
directory in 'label'; the last string is the basename."""
components = []
while label:
dirname, label = self.SplitLabelLeft(label)
if dirname:
components.append(dirname)
else:
components.append(label)
break
return components
# Generic methods that deal with extensions.
def GetExtension(self, id):
"""Return the extension object named 'id'.
'id' -- The label for the extension.
returns -- The instance of 'Extension' with the indicated name,
or 'None' if there is no such entity.
Database classes should override this method. For backwards
compatibility, this base class implements this generic method
in terms of the special-purpose methods 'GetTest()' and 'GetResource()'.
Only if _is_generic_database is True are these implemented in terms
of 'GetExtension()'."""
for kind in (Database.TEST, Database.RESOURCE):
try:
return self.GetItem(kind, id).GetItem()
except NoSuchItemError:
pass
try:
return self.GetSuite(id)
except NoSuchSuiteError:
pass
return None
def GetExtensions(self, directory, scan_subdirs):
"""Return the extensions in 'directory'.
'directory' -- The name of a directory.
'scan_subdirs' -- True if (and only if) subdirectories of
'directory' should be scanned.
returns -- A dictionary mapping labels to 'Extension'
instances. The dictionary contains all extensions in
'directory', and, if 'scan_subdirs' is true, its
subdirectories."""
extensions = {}
for kind in self.ITEM_KINDS:
ids = self.GetIds(kind, directory, scan_subdirs)
for id in ids:
extensions[id] = self.GetExtension(id)
return extensions
def RemoveExtension(self, id, kind):
"""Remove the extension 'id' from the database.
'id' -- A label for the 'Extension' instance stored in the
database.
'kind' -- The kind of 'Extension' stored with the given 'id'."""
raise NotImplementedError
def WriteExtension(self, id, extension):
"""Store 'extension' in the database, using the name 'id'.
'id' -- A label for the 'extension'.
'extension' -- An instance of 'Extension'.
The 'extension' is stored in the database. If there is a
previous item in the database with the same id, it is removed
and replaced with 'extension'. Some databases may not be able
to store all 'Extension' instances; those database must throw an
exception when an attempt is made to store such an
'extension'."""
raise NotImplementedError
# Methods that deal with tests.
def GetTest(self, test_id):
"""Return the 'TestDescriptor' for the test named 'test_id'.
'test_id' -- A label naming the test.
returns -- A 'TestDescriptor' corresponding to 'test_id'.
raises -- 'NoSuchTestError' if there is no test in the database
named 'test_id'."""
if self._is_generic_database:
test = self.GetExtension(test_id)
if isinstance(test, Test):
return TestDescriptor(self, test_id, test=test)
raise NoSuchTestError(test_id)
def HasTest(self, test_id):
"""Check whether or not the database has a test named 'test_id'.
'test_id' -- A label naming the test.
returns -- True if and only if the database contains a test
named 'test_id'. If this function returns true, 'GetTest' will
usually succeed. However, they may be circumstances where
'HasTest' returns true and 'GetTest' does not succeed. For
example, someone might remove a critical file from the database
between the time that 'HasTest' is called and the time that
'GetTest' is called.
Derived classes may override this method."""
try:
self.GetTest(test_id)
except NoSuchTestError:
return 0
else:
return 1
def GetTestIds(self, directory="", scan_subdirs=1):
"""Return all test IDs that begin with 'directory'.
'directory' -- A label indicating the directory in which to
begin the search.
'scan_subdirs' -- True if (and only if) subdirectories of
'directory' should be scanned.
'returns' -- A list of all tests located within 'directory',
as absolute labels."""
return self.GetIds(self.TEST, directory, scan_subdirs)
# Methods that deal with suites.
def GetSuite(self, suite_id):
"""Return the 'Suite' for the suite named 'suite_id'.
'suite_id' -- A label naming the suite.
returns -- An instance of 'Suite' (or a derived class of
'Suite') corresponding to 'suite_id'.
raises -- 'NoSuchSuiteError' if there is no test in the database
named 'test_id'.
All databases must have an implicit suite called '' that
contains all tests in the database. More generally, for each
directory in the database, there must be a corresponding suite
that contains all tests in that directory and its
subdirectories."""
if suite_id == "":
return DirectorySuite(self, "")
if self._is_generic_database:
suite = self.GetExtension(suite_id)
if isinstance(suite, Suite):
return suite
raise NoSuchSuiteError(suite_id)
def HasSuite(self, suite_id):
"""Check whether or not the database has a suite named 'suite_id'.
'suite_id' -- A label naming the suite.
returns -- True if and only if the database contains a suite
named 'suite_id'. If this function returns true, 'GetSuite'
will usually succeed. However, they may be circumstances where
'HasSuite' returns true and 'GetSuite' does not succeed. For
example, someone might remove a critical file from the database
between the time that 'HasSuite' is called and the time that
'GetSuite' is called.
All databases must have an implicit suite called "" that
contains all tests in the database. More generally, for each
directory in the database, there must be a corresponding suite
that contains all tests in that directory and its
subdirectories.
Derived classes may override this method."""
try:
self.GetSuite(suite_id)
except NoSuchSuiteError:
return 0
else:
return 1
def GetSuiteIds(self, directory="", scan_subdirs=1):
"""Return all suite IDs that begin with 'directory'.
'directory' -- A label indicating the directory in which to
begin the search.
'scan_subdirs' -- True if (and only if) subdirectories of
'directory' should be scanned.
'returns' -- A list of all suites located within 'directory',
as absolute labels."""
return self.GetIds(self.SUITE, directory, scan_subdirs)
# Methods that deal with resources.
def GetResource(self, resource_id):
"""Return the 'ResourceDescriptor' for the resource 'resouce_id'.
'resource_id' -- A label naming the resource.
returns -- A 'ResourceDescriptor' corresponding to 'resource_id'.
raises -- 'NoSuchResourceError' if there is no resource in the
database named 'resource_id'."""
if self._is_generic_database:
resource = self.GetExtension(resource_id)
if isinstance(resource, Resource):
return ResourceDescriptor(self, resource_id, resource = resource)
raise NoSuchResourceError(resource_id)
def HasResource(self, resource_id):
"""Check whether or not the database has a resource named
'resource_id'.
'resource_id' -- A label naming the resource.
returns -- True if and only if the database contains a resource
named 'resource_id'. If this function returns true,
'GetResource' will usually succeed. However, they may be
circumstances where 'HasResource' returns true and 'GetResource'
does not succeed. For example, someone might remove a critical
file from the database between the time that 'HasResource' is
called and the time that 'GetResource' is called.
Derived classes may override this method."""
try:
self.GetResource(resource_id)
except NoSuchResourceError:
return 0
else:
return 1
def GetResourceIds(self, directory="", scan_subdirs=1):
"""Return all resource IDs that begin with 'directory'.
'directory' -- A label indicating the directory in which to
begin the search.
'scan_subdirs' -- True if (and only if) subdirectories of
'directory' should be scanned.
'returns' -- A list of all resources located within 'directory',
as absolute labels."""
return self.GetIds(self.RESOURCE, directory, scan_subdirs)
# Miscellaneous methods.
def GetIds(self, kind, directory = "", scan_subdirs = 1):
"""Return all IDs of the indicated 'kind' that begin with 'directory'.
'kind' -- One of the 'ITEM_KINDS'.
'directory' -- A label indicating the directory in which to
begin the search.
'scan_subdirs' -- True if (and only if) subdirectories of
'directory' should be scanned.
returns -- A list of all items of the indicated 'kind' located
within 'directory', as absolute labels.
Derived classes may override this method."""
if self._is_generic_database:
extensions = self.GetExtensions(directory, scan_subdirs)
extensions = filter(lambda e: e.kind == kind,
extensions.values())
return map(lambda e: e.GetId(), extensions)
return []
def GetItem(self, kind, item_id):
"""Return the item of the indicated 'kind' with indicated 'item_id'.
'kind' -- One of the 'ITEM_KINDS'.
'item_id' -- The name of the item.
returns -- If 'kind' is 'Database.TEST' or 'Database.RESOURCE',
returns a test descriptor or resource descriptor, respectively.
If 'kind' is 'Database.SUITE', returns a 'Suite'.
Derived classes may override this method."""
return { Database.TEST : self.GetTest,
Database.RESOURCE : self.GetResource,
Database.SUITE : self.GetSuite } [kind] (item_id)
def GetSubdirectories(self, directory):
"""Return the immediate subdirectories of 'directory'.
'directory' -- A label indicating a directory in the database.
returns -- A sequence of (relative) labels indictating the
immediate subdirectories of 'directory'. For example, if "a.b"
and "a.c" are directories in the database, this method will
return "b" and "c" given "a" as 'directory'.
Derived classes may override this method."""
return []
def GetPath(self):
"""Return the directory containing the database.
returns -- A string containing the absolute path to the
directory containing the database.
Derived classes must not override this method."""
return self.__path
def GetConfigurationDirectory(self):
"""Return the directory containing configuration information.
returns -- The directory containing configuration information
for the database.
Derived classes must not override this method."""
return get_configuration_directory(self.GetPath())
def GetAttachmentStore(self):
"""Returns the 'AttachmentStore' associated with the database.
returns -- The 'AttachmentStore' containing the attachments
associated with tests and resources in this database.
Derived classes may override this method."""
return None
def GetClassPaths(self):
"""Return directories to search for test and resource classes.
returns -- A sequence of strings. Each string is a directory
that should be searched to locate test and resource classes.
The directories will be searched in the order they appear.
QMTest will search other directories (like those in the
'QMTEST_CLASS_PATH' environment variable) in addition to these
directories.
For a given database, this method should always return the same
value; callers are permitted to cache the value returned.
Derived classes may override this method. The sequence returned
by the derived class need not be a superset of the value
returned by the default implementation (but probably should
be)."""
return []
def GetTestClassNames(self):
"""Return the kinds of tests that the database can store.
returns -- A sequence of strings. Each string names a
class, including the containing module. Only classes
of these types can be stored in the database.
Derived classes may override this method. The default
implementation allows all available test classes, but the
derived class may allow only a subset."""
return get_extension_class_names('test', self)
def GetResourceClassNames(self):
"""Return the kinds of resources that the database can store.
returns -- A sequence of strings. Each string names a
class, including the containing module. Only resources
of these types can be stored in the database.
Derived classes may override this method. The default
implementation allows all available resource classes, but the
derived class may allow only a subset."""
return get_extension_class_names('resource', self)
def ExpandIds(self, ids):
"""Expand test and suite IDs into test IDs.
'ids' -- A sequence of IDs of tests and suites, which may be mixed
together.
returns -- A pair 'test_ids, suite_ids'. 'test_ids' is a
sequence of test IDs including all test IDs mentioned in 'ids' plus
all test IDs obtained from recursively expanding suites included in
'ids'. 'suite_ids' is the set of IDs of suites included directly
and indirectly in 'ids'.
raises -- 'ValueError' if an element in 'id' is neither a test or
suite ID. The exception argument is the erroneous element."""
# We'll collect test and suite IDs in maps, to make duplicate
# checks efficient.
test_ids = {}
suite_ids = {}
for id in ids:
# Skip this ID if we've already seen it.
if suite_ids.has_key(id) or test_ids.has_key(id):
continue
# Is this a suite ID?
if self.HasSuite(id):
suite_ids[id] = None
# Yes. Load the suite.
suite = self.GetSuite(id)
# Determine all the tests and suites contained directly and
# indirectly in this suite.
suite_test_ids, sub_suite_ids = suite.GetAllTestAndSuiteIds()
# Add them.
for test_id in suite_test_ids:
test_ids[test_id] = None
for suite_id in sub_suite_ids:
suite_ids[suite_id] = None
# Or is this a test ID?
elif self.HasTest(id):
# Yes. Add it.
test_ids[id] = None
else:
# It doesn't look like a test or suite ID.
raise ValueError, id
# Convert the maps to sequences.
return test_ids.keys(), suite_ids.keys()
def IsModifiable(self):
"""Returns true iff this database is modifiable.
returns -- True iff this database is modifiable. If the
database is modifiable, it supports operatings like 'Write'
that make changes to the structure of the databaes itself.
Otherwise, the contents of the database may be viewed, but not
modified."""
return self.modifiable == "true"
########################################################################
# Functions
########################################################################
def get_configuration_directory(path):
"""Return the configuration directory for the 'Database' rooted at 'path'.
'path' -- The path to the test database.
returns -- The path to the configuration directory."""
return os.path.join(path, "QMTest")
def get_configuration_file(path):
"""Return the configuration file for the 'Database' rooted at 'path'.
'path' -- The path to the test database.
returns -- The path to the configuration file."""
return os.path.join(get_configuration_directory(path),
"configuration")
def is_database(db_path):
"""Returns true if 'db_path' looks like a test database."""
# A test database is a directory.
if not os.path.isdir(db_path):
return 0
# A test database contains a configuration file.
if not os.path.isfile(get_configuration_file(db_path)):
return 0
# It probably is OK.
return 1
def load_database(db_path):
"""Load the database from 'db_path'.
'db_path' -- The path to the directory containing the database.
returns -- The new 'Database'."""
# Make sure it is a directory.
if not is_database(db_path):
raise QMException, \
qm.error("not test database", path=db_path)
# Load the file.
config_path = get_configuration_file(db_path)
document = qm.xmlutil.load_xml_file(config_path)
# Parse it.
database_class, arguments \
= (qm.extension.parse_dom_element
(document.documentElement,
lambda n: qm.test.base.get_extension_class(n, "database",
None, db_path)))
# For backwards compatibility with QM 1.1.x, we look for "attribute"
# elements.
for node in document.documentElement.getElementsByTagName("attribute"):
name = node.getAttribute("name")
# These elements were only allowed to contain strings as
# values.
value = qm.xmlutil.get_dom_text(node)
# Python does not allow keyword arguments to have Unicode
# values, so we convert the name to an ordinary string.
arguments[str(name)] = value
return database_class(db_path, arguments)
########################################################################
# Functions
########################################################################
def set_path(path):
"""Set the database path to be used when the database is loaded.
'path' -- A string containing the path to the database."""
global __the_db_path
__the_db_path = path
def get_database():
"""Returns the global Database object.
returns -- The 'Database' object that corresponds to the currently
executing process. It may be None."""
global __the_database
if not __the_database:
__the_database = load_database(__the_db_path)
return __the_database
########################################################################
# Local Variables:
# mode: python
# indent-tabs-mode: nil
# fill-column: 72
# End:
|