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

branch
eric7
changeset 10407
03b41b9bb392
parent 10259
b51dfacef37f
child 10415
af9a6dac2611
--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html	Wed Dec 13 16:03:41 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html	Wed Dec 13 16:04:40 2023 +0100
@@ -56,7 +56,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>collectCoverage</td></tr><tr><td>coverageFile</td></tr><tr><td>discover</td></tr><tr><td>discoveryStart</td></tr><tr><td>eraseCoverage</td></tr><tr><td>failFast</td></tr><tr><td>failedOnly</td></tr><tr><td>interpreter</td></tr><tr><td>testFilename</td></tr><tr><td>testMarkerExpression</td></tr><tr><td>testName</td></tr><tr><td>testNamePattern</td></tr>
+<tr><td>collectCoverage</td></tr><tr><td>coverageFile</td></tr><tr><td>discover</td></tr><tr><td>discoverOnly</td></tr><tr><td>discoveryStart</td></tr><tr><td>eraseCoverage</td></tr><tr><td>failFast</td></tr><tr><td>failedOnly</td></tr><tr><td>interpreter</td></tr><tr><td>testCases</td></tr><tr><td>testFilename</td></tr><tr><td>testMarkerExpression</td></tr><tr><td>testName</td></tr><tr><td>testNamePattern</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -92,17 +92,28 @@
         are encountered during test collection. Tuple elements are the
         test name and the error message.
 </dd>
-<dt>collected(list of tuple of (str, str, str)</dt>
+<dt>collected(list of tuple of (str, str, str, str, int, list)</dt>
 <dd>
-) emitted after all tests
-        have been collected. Tuple elements are the test id, the test name and
-        a short description of the test.
+) emitted after
+        all tests have been collected. Tuple elements are the test id, the test name,
+        a short description of the test, the test file name, the line number of
+        the test and the elements of the test path as a list.
 </dd>
 <dt>coverageDataSaved(str)</dt>
 <dd>
 emitted after the coverage data was saved.
         The element is the absolute path of the coverage data file.
 </dd>
+<dt>discoveryAboutToBeStarted()</dt>
+<dd>
+emitted just before the test discovery
+        will be started
+</dd>
+<dt>discoveryFinished(int, float)</dt>
+<dd>
+emitted when the discovery has finished.
+        The elements are the number of discovered tests and the duration in seconds.
+</dd>
 <dt>startTest(tuple of (str, str, str)</dt>
 <dd>
 emitted before tests are run.
@@ -130,7 +141,7 @@
 <dt>testRunFinished(int, float)</dt>
 <dd>
 emitted when the test run has finished.
-        The elements are the number of tests run and the duration in seconds
+        The elements are the number of tests run and the duration in seconds.
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -166,6 +177,10 @@
 <td>Public method to create the arguments needed to start the test process.</td>
 </tr>
 <tr>
+<td><a href="#TestExecutorBase.discover">discover</a></td>
+<td>Public method to start the test discovery process.</td>
+</tr>
+<tr>
 <td><a href="#TestExecutorBase.finished">finished</a></td>
 <td>Public method handling the unit test process been finished.</td>
 </tr>
@@ -315,6 +330,36 @@
             derived classes
 </dd>
 </dl>
+<a NAME="TestExecutorBase.discover" ID="TestExecutorBase.discover"></a>
+<h4>TestExecutorBase.discover</h4>
+<b>discover</b>(<i>config, pythonpath</i>)
+
+<p>
+        Public method to start the test discovery process.
+</p>
+<dl>
+
+<dt><i>config</i> (TestConfig)</dt>
+<dd>
+configuration for the test discovery
+</dd>
+<dt><i>pythonpath</i> (list of str)</dt>
+<dd>
+list of directories to be added to the Python path
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised if the the test discovery process did not start
+</dd>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised if no start directory for the test discovery was
+            given
+</dd>
+</dl>
 <a NAME="TestExecutorBase.finished" ID="TestExecutorBase.finished"></a>
 <h4>TestExecutorBase.finished</h4>
 <b>finished</b>(<i></i>)

eric ide

mercurial