src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestFrameworkRegistry.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9097
213951c41dcd
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Testing.Interfaces.TestFrameworkRegistry</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Testing.Interfaces.TestFrameworkRegistry</h1>
10
11 <p>
12 Module implementing a simple registry containing the available test framework
13 interfaces.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#TestFrameworkRegistry">TestFrameworkRegistry</a></td>
26 <td>Class implementing a simple registry of test framework interfaces.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="TestFrameworkRegistry" ID="TestFrameworkRegistry"></a>
37 <h2>TestFrameworkRegistry</h2>
38
39 <p>
40 Class implementing a simple registry of test framework interfaces.
41 </p>
42 <p>
43 The test executor for a framework is responsible for running the tests,
44 receiving the results and preparing them for display. It must implement
45 the interface of TestExecutorBase.
46 </p>
47 <p>
48 Frameworks must first be registered using '.register()'. This registry
49 can then create the assoicated test executor when '.createExecutor()' is
50 called.
51 </p>
52 <h3>Derived from</h3>
53 None
54 <h3>Class Attributes</h3>
55
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65
66 <table>
67
68 <tr>
69 <td><a href="#TestFrameworkRegistry.__init__">TestFrameworkRegistry</a></td>
70 <td>Constructor</td>
71 </tr>
72 <tr>
73 <td><a href="#TestFrameworkRegistry.createExecutor">createExecutor</a></td>
74 <td>Public method to create a test framework executor.</td>
75 </tr>
76 <tr>
77 <td><a href="#TestFrameworkRegistry.getFrameworks">getFrameworks</a></td>
78 <td>Public method to get a copy of the registered frameworks.</td>
79 </tr>
80 <tr>
81 <td><a href="#TestFrameworkRegistry.register">register</a></td>
82 <td>Public method to register a test framework executor.</td>
83 </tr>
84 </table>
85 <h3>Static Methods</h3>
86
87 <table>
88 <tr><td>None</td></tr>
89 </table>
90
91 <a NAME="TestFrameworkRegistry.__init__" ID="TestFrameworkRegistry.__init__"></a>
92 <h4>TestFrameworkRegistry (Constructor)</h4>
93 <b>TestFrameworkRegistry</b>(<i></i>)
94
95 <p>
96 Constructor
97 </p>
98 <a NAME="TestFrameworkRegistry.createExecutor" ID="TestFrameworkRegistry.createExecutor"></a>
99 <h4>TestFrameworkRegistry.createExecutor</h4>
100 <b>createExecutor</b>(<i>framework, widget</i>)
101
102 <p>
103 Public method to create a test framework executor.
104 </p>
105 <p>
106 Note: The executor classes have to be registered first.
107 </p>
108 <dl>
109
110 <dt><i>framework</i> (str)</dt>
111 <dd>
112 name of the test framework
113 </dd>
114 <dt><i>widget</i> (TestingWidget)</dt>
115 <dd>
116 reference to the unit test widget
117 </dd>
118 </dl>
119 <dl>
120 <dt>Return:</dt>
121 <dd>
122 test framework executor object
123 </dd>
124 </dl>
125 <dl>
126 <dt>Return Type:</dt>
127 <dd>
128 TestExecutorBase
129 </dd>
130 </dl>
131 <a NAME="TestFrameworkRegistry.getFrameworks" ID="TestFrameworkRegistry.getFrameworks"></a>
132 <h4>TestFrameworkRegistry.getFrameworks</h4>
133 <b>getFrameworks</b>(<i></i>)
134
135 <p>
136 Public method to get a copy of the registered frameworks.
137 </p>
138 <dl>
139 <dt>Return:</dt>
140 <dd>
141 copy of the registered frameworks
142 </dd>
143 </dl>
144 <dl>
145 <dt>Return Type:</dt>
146 <dd>
147 dict
148 </dd>
149 </dl>
150 <a NAME="TestFrameworkRegistry.register" ID="TestFrameworkRegistry.register"></a>
151 <h4>TestFrameworkRegistry.register</h4>
152 <b>register</b>(<i>executorClass</i>)
153
154 <p>
155 Public method to register a test framework executor.
156 </p>
157 <dl>
158
159 <dt><i>executorClass</i> (TestExecutorBase)</dt>
160 <dd>
161 class implementing the test framework executor
162 </dd>
163 </dl>
164 <div align="right"><a href="#top">Up</a></div>
165 <hr />
166 </body></html>

eric ide

mercurial