/usr/share/pyshared/qm/test/resource.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 | ########################################################################
#
# File: resource.py
# Author: Mark Mitchell
# Date: 2001-10-10
#
# Contents:
# QMTest Resource class.
#
# Copyright (c) 2001, 2002, 2003 by CodeSourcery, LLC. All rights reserved.
#
# For license terms see the file COPYING.
#
########################################################################
########################################################################
# Imports
########################################################################
import qm
import qm.test.runnable
########################################################################
# Classes
########################################################################
class Resource(qm.test.runnable.Runnable):
"""A 'Resource' sets up before a test and cleans up afterwards.
Some tests take a lot of work to set up. For example, a database
test that checks the result of SQL queries may require that the
database first be populated with a substantial number of records.
If there are many tests that all use the same set of records, it
would be wasteful to set up the database for each test. It would
be more efficient to set up the database once, run all of the
tests, and then remove the databases upon completion.
You can use a 'Resource' to gain this efficiency. If a test
depends on a resource, QMTest will ensure that the resource is
available before the test runs. Once all tests that depend on the
resource have been run QMTest will destroy the resource.
Each resource class (i.e., class derived from 'Resource')
describes a set of "arguments". Each argument has a name and a
type. The values of these arguments determine the design-time
parameters for the resource. See the documentation for the 'Test'
class for more complete information.
Each resource class also defines a 'SetUp' method that indicates how
to set up the resource, and a 'CleanUp' method that indicates how
to clean up afterwards.
'Resource' is an abstract class.
You can extend QMTest by providing your own resource class
implementation. If the resource classes that come with QMTest
cannot be used conveniently with your application domain, you may
wish to create a new resource class.
To create your own resource class, you must create a Python class
derived (directly or indirectly) from 'Resource'. The
documentation for each method of 'Resource' indicates whether you
must override it in your resource class 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 resource and that method raises an
exception that is not caught within the method itself, QMTest will
catch the exception and continue processing."""
kind = "resource"
def SetUp(self, context, result):
"""Set up the resource.
'context' -- A 'Context' giving run-time parameters to the
resource. The resource may place additional variables into
the 'context'; these variables will be visible to tests that
depend on the resource.
'result' -- A 'Result' object. The outcome will be
'Result.PASS' when this method is called. The 'result' may be
modified by this method to indicate outcomes other than
'Result.PASS' or to add annotations.
This method should not return a value.
Derived classes must override this method."""
raise NotImplementedError
def CleanUp(self, result):
"""Clean up the resource.
'result' -- A 'Result' object. The outcome will be
'Result.PASS' when this method is called. The 'result' may be
modified by this method to indicate outcomes other than
'Result.PASS' or to add annotations.
This method should not return a value.
Derived classes may override this method."""
pass
|