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

<!DOCTYPE html>
<html><head>
<title>eric7.Testing.Interfaces.TestFrameworkRegistry</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Testing.Interfaces.TestFrameworkRegistry</h1>

<p>
Module implementing a simple registry containing the available test framework
interfaces.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#TestFrameworkRegistry">TestFrameworkRegistry</a></td>
<td>Class implementing a simple registry of test framework interfaces.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="TestFrameworkRegistry" ID="TestFrameworkRegistry"></a>
<h2>TestFrameworkRegistry</h2>

<p>
    Class implementing a simple registry of test framework interfaces.
</p>
<p>
    The test executor for a framework is responsible for running the tests,
    receiving the results and preparing them for display. It must implement
    the interface of TestExecutorBase.
</p>
<p>
    Frameworks must first be registered using '.register()'. This registry
    can then create the assoicated test executor when '.createExecutor()' is
    called.
</p>
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#TestFrameworkRegistry.__init__">TestFrameworkRegistry</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#TestFrameworkRegistry.createExecutor">createExecutor</a></td>
<td>Public method to create a test framework executor.</td>
</tr>
<tr>
<td><a href="#TestFrameworkRegistry.getFrameworks">getFrameworks</a></td>
<td>Public method to get a copy of the registered frameworks.</td>
</tr>
<tr>
<td><a href="#TestFrameworkRegistry.register">register</a></td>
<td>Public method to register a test framework executor.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="TestFrameworkRegistry.__init__" ID="TestFrameworkRegistry.__init__"></a>
<h4>TestFrameworkRegistry (Constructor)</h4>
<b>TestFrameworkRegistry</b>(<i></i>)

<p>
        Constructor
</p>
<a NAME="TestFrameworkRegistry.createExecutor" ID="TestFrameworkRegistry.createExecutor"></a>
<h4>TestFrameworkRegistry.createExecutor</h4>
<b>createExecutor</b>(<i>framework, widget</i>)

<p>
        Public method to create a test framework executor.
</p>
<p>
        Note: The executor classes have to be registered first.
</p>
<dl>

<dt><i>framework</i> (str)</dt>
<dd>
name of the test framework
</dd>
<dt><i>widget</i> (TestingWidget)</dt>
<dd>
reference to the unit test widget
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
test framework executor object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
TestExecutorBase
</dd>
</dl>
<a NAME="TestFrameworkRegistry.getFrameworks" ID="TestFrameworkRegistry.getFrameworks"></a>
<h4>TestFrameworkRegistry.getFrameworks</h4>
<b>getFrameworks</b>(<i></i>)

<p>
        Public method to get a copy of the registered frameworks.
</p>
<dl>
<dt>Return:</dt>
<dd>
copy of the registered frameworks
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="TestFrameworkRegistry.register" ID="TestFrameworkRegistry.register"></a>
<h4>TestFrameworkRegistry.register</h4>
<b>register</b>(<i>executorClass</i>)

<p>
        Public method to register a test framework executor.
</p>
<dl>

<dt><i>executorClass</i> (TestExecutorBase)</dt>
<dd>
class implementing the test framework executor
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>