--- a/src/eric7/Documentation/Source/eric7.Testing.TestingWidget.html Wed Dec 13 16:03:41 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Testing.TestingWidget.html Wed Dec 13 16:04:40 2023 +0100 @@ -68,7 +68,7 @@ <h3>Class Attributes</h3> <table> -<tr><td>None</td></tr> +<tr><td>TestCaseFileRole</td></tr><tr><td>TestCaseIdRole</td></tr><tr><td>TestCaseLinenoRole</td></tr><tr><td>TestCaseNameRole</td></tr> </table> <h3>Class Methods</h3> @@ -96,6 +96,14 @@ <td>Private method to determine the interpreter to be used.</td> </tr> <tr> +<td><a href="#TestingWidget.__discoverTests">__discoverTests</a></td> +<td>Private slot to discover tests but don't execute them.</td> +</tr> +<tr> +<td><a href="#TestingWidget.__findDiscoveryItem">__findDiscoveryItem</a></td> +<td>Private method to find an item given the module path.</td> +</tr> +<tr> <td><a href="#TestingWidget.__insertDiscovery">__insertDiscovery</a></td> <td>Private slot to insert the discovery start directory into the discoveryPicker object.</td> </tr> @@ -148,6 +156,14 @@ <td>Private method to save the most recently used lists.</td> </tr> <tr> +<td><a href="#TestingWidget.__selectedTestCases">__selectedTestCases</a></td> +<td>Private method to assemble the list of selected test cases and suites.</td> +</tr> +<tr> +<td><a href="#TestingWidget.__setDiscoverMode">__setDiscoverMode</a></td> +<td>Private slot to switch the widget to test discovery mode.</td> +</tr> +<tr> <td><a href="#TestingWidget.__setIdleMode">__setIdleMode</a></td> <td>Private slot to switch the widget to idle mode.</td> </tr> @@ -180,6 +196,18 @@ <td>Private slot to stop the current test run.</td> </tr> <tr> +<td><a href="#TestingWidget.__testDiscoveryAboutToBeStarted">__testDiscoveryAboutToBeStarted</a></td> +<td>Private slot to handle the 'testDiscoveryAboutToBeStarted' signal of the executor.</td> +</tr> +<tr> +<td><a href="#TestingWidget.__testDiscoveryError">__testDiscoveryError</a></td> +<td>Private slot handling the 'collectError' signal of the executor.</td> +</tr> +<tr> +<td><a href="#TestingWidget.__testDiscoveryProcessFinished">__testDiscoveryProcessFinished</a></td> +<td>Private slot to handle the 'testFinished' signal of the executor in discovery mode.</td> +</tr> +<tr> <td><a href="#TestingWidget.__testProcessFinished">__testProcessFinished</a></td> <td>Private slot to handle the 'testFinished' signal of the executor.</td> </tr> @@ -204,6 +232,10 @@ <td>Private slot handling the 'collected' signal of the executor.</td> </tr> <tr> +<td><a href="#TestingWidget.__testsDiscovered">__testsDiscovered</a></td> +<td>Private slot handling the 'collected' signal of the executor in discovery mode.</td> +</tr> +<tr> <td><a href="#TestingWidget.__testsStopped">__testsStopped</a></td> <td>Private slot to handle the 'stop' signal of the executor.</td> </tr> @@ -228,6 +260,10 @@ <td>Private slot to update the progress indicators.</td> </tr> <tr> +<td><a href="#TestingWidget.__updateStatusFilterComboBox">__updateStatusFilterComboBox</a></td> +<td>Private method to update the status filter dialog box.</td> +</tr> +<tr> <td><a href="#TestingWidget.clearRecent">clearRecent</a></td> <td>Public slot to clear the recently used lists.</td> </tr> @@ -256,6 +292,18 @@ <td>Private slot handling state changes of the 'discover' checkbox.</td> </tr> <tr> +<td><a href="#TestingWidget.on_discoveryList_itemActivated">on_discoveryList_itemActivated</a></td> +<td>Private slot handling the user activating an item.</td> +</tr> +<tr> +<td><a href="#TestingWidget.on_discoveryList_itemChanged">on_discoveryList_itemChanged</a></td> +<td>Private slot handling the user checking or unchecking an item.</td> +</tr> +<tr> +<td><a href="#TestingWidget.on_discoveryPicker_editTextChanged">on_discoveryPicker_editTextChanged</a></td> +<td>Private slot to handle a change of the discovery start directory.</td> +</tr> +<tr> <td><a href="#TestingWidget.on_frameworkComboBox_currentIndexChanged">on_frameworkComboBox_currentIndexChanged</a></td> <td>Private slot handling the selection of a test framework.</td> </tr> @@ -264,6 +312,10 @@ <td>Private slot to show a window containing the list of defined markers.</td> </tr> <tr> +<td><a href="#TestingWidget.on_statusFilterComboBox_currentTextChanged">on_statusFilterComboBox_currentTextChanged</a></td> +<td>Private slot handling the selection of a status for items to be shown.</td> +</tr> +<tr> <td><a href="#TestingWidget.on_testsuitePicker_aboutToShowPathPickerDialog">on_testsuitePicker_aboutToShowPathPickerDialog</a></td> <td>Private slot called before the test file selection dialog is shown.</td> </tr> @@ -356,6 +408,39 @@ str </dd> </dl> +<a NAME="TestingWidget.__discoverTests" ID="TestingWidget.__discoverTests"></a> +<h4>TestingWidget.__discoverTests</h4> +<b>__discoverTests</b>(<i></i>) + +<p> + Private slot to discover tests but don't execute them. +</p> +<a NAME="TestingWidget.__findDiscoveryItem" ID="TestingWidget.__findDiscoveryItem"></a> +<h4>TestingWidget.__findDiscoveryItem</h4> +<b>__findDiscoveryItem</b>(<i>modulePath</i>) + +<p> + Private method to find an item given the module path. +</p> +<dl> + +<dt><i>modulePath</i> (str)</dt> +<dd> +path of the module in dotted notation +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the item or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem or None +</dd> +</dl> <a NAME="TestingWidget.__insertDiscovery" ID="TestingWidget.__insertDiscovery"></a> <h4>TestingWidget.__insertDiscovery</h4> <b>__insertDiscovery</b>(<i>start</i>) @@ -507,6 +592,39 @@ <p> Private method to save the most recently used lists. </p> +<a NAME="TestingWidget.__selectedTestCases" ID="TestingWidget.__selectedTestCases"></a> +<h4>TestingWidget.__selectedTestCases</h4> +<b>__selectedTestCases</b>(<i>parent=None</i>) + +<p> + Private method to assemble the list of selected test cases and suites. +</p> +<dl> + +<dt><i>parent</i> (QTreeWidgetItem)</dt> +<dd> +reference to the parent item +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of selected test cases +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="TestingWidget.__setDiscoverMode" ID="TestingWidget.__setDiscoverMode"></a> +<h4>TestingWidget.__setDiscoverMode</h4> +<b>__setDiscoverMode</b>(<i></i>) + +<p> + Private slot to switch the widget to test discovery mode. +</p> <a NAME="TestingWidget.__setIdleMode" ID="TestingWidget.__setIdleMode"></a> <h4>TestingWidget.__setIdleMode</h4> <b>__setIdleMode</b>(<i></i>) @@ -582,6 +700,49 @@ <p> Private slot to stop the current test run. </p> +<a NAME="TestingWidget.__testDiscoveryAboutToBeStarted" ID="TestingWidget.__testDiscoveryAboutToBeStarted"></a> +<h4>TestingWidget.__testDiscoveryAboutToBeStarted</h4> +<b>__testDiscoveryAboutToBeStarted</b>(<i></i>) + +<p> + Private slot to handle the 'testDiscoveryAboutToBeStarted' signal of the + executor. +</p> +<a NAME="TestingWidget.__testDiscoveryError" ID="TestingWidget.__testDiscoveryError"></a> +<h4>TestingWidget.__testDiscoveryError</h4> +<b>__testDiscoveryError</b>(<i>errors</i>) + +<p> + Private slot handling the 'collectError' signal of the executor. +</p> +<dl> + +<dt><i>errors</i> (list of tuple of (str, str))</dt> +<dd> +list of tuples containing the test name and a description + of the error +</dd> +</dl> +<a NAME="TestingWidget.__testDiscoveryProcessFinished" ID="TestingWidget.__testDiscoveryProcessFinished"></a> +<h4>TestingWidget.__testDiscoveryProcessFinished</h4> +<b>__testDiscoveryProcessFinished</b>(<i>results, output</i>) + +<p> + Private slot to handle the 'testFinished' signal of the executor in + discovery mode. +</p> +<dl> + +<dt><i>results</i> (list of TestResult)</dt> +<dd> +list of test result objects (if not sent via the + 'testResult' signal) +</dd> +<dt><i>output</i> (str)</dt> +<dd> +string containing the test process output (if any) +</dd> +</dl> <a NAME="TestingWidget.__testProcessFinished" ID="TestingWidget.__testProcessFinished"></a> <h4>TestingWidget.__testProcessFinished</h4> <b>__testProcessFinished</b>(<i>results, output</i>) @@ -666,10 +827,28 @@ </p> <dl> -<dt><i>testNames</i> (list of tuple of (str, str, str))</dt> +<dt><i>testNames</i> (list of tuple of (str, str, str, str, int, list))</dt> <dd> list of tuples containing the test id, the test name - and a description of collected tests + a description, the file name, the line number and the test path as a list + of collected tests +</dd> +</dl> +<a NAME="TestingWidget.__testsDiscovered" ID="TestingWidget.__testsDiscovered"></a> +<h4>TestingWidget.__testsDiscovered</h4> +<b>__testsDiscovered</b>(<i>testNames</i>) + +<p> + Private slot handling the 'collected' signal of the executor in discovery + mode. +</p> +<dl> + +<dt><i>testNames</i> (list of tuple of (str, str, str, str, int, list))</dt> +<dd> +list of tuples containing the test id, the test name + a description, the file name, the line number and the test path as a list + of collected tests </dd> </dl> <a NAME="TestingWidget.__testsStopped" ID="TestingWidget.__testsStopped"></a> @@ -717,6 +896,13 @@ <p> Private slot to update the progress indicators. </p> +<a NAME="TestingWidget.__updateStatusFilterComboBox" ID="TestingWidget.__updateStatusFilterComboBox"></a> +<h4>TestingWidget.__updateStatusFilterComboBox</h4> +<b>__updateStatusFilterComboBox</b>(<i></i>) + +<p> + Private method to update the status filter dialog box. +</p> <a NAME="TestingWidget.clearRecent" ID="TestingWidget.clearRecent"></a> <h4>TestingWidget.clearRecent</h4> <b>clearRecent</b>(<i></i>) @@ -824,6 +1010,56 @@ state of the checkbox </dd> </dl> +<a NAME="TestingWidget.on_discoveryList_itemActivated" ID="TestingWidget.on_discoveryList_itemActivated"></a> +<h4>TestingWidget.on_discoveryList_itemActivated</h4> +<b>on_discoveryList_itemActivated</b>(<i>item, column</i>) + +<p> + Private slot handling the user activating an item. +</p> +<dl> + +<dt><i>item</i> (QTreeWidgetItem)</dt> +<dd> +reference to the item +</dd> +<dt><i>column</i> (int)</dt> +<dd> +column of the double click +</dd> +</dl> +<a NAME="TestingWidget.on_discoveryList_itemChanged" ID="TestingWidget.on_discoveryList_itemChanged"></a> +<h4>TestingWidget.on_discoveryList_itemChanged</h4> +<b>on_discoveryList_itemChanged</b>(<i>item, column</i>) + +<p> + Private slot handling the user checking or unchecking an item. +</p> +<dl> + +<dt><i>item</i> (QTreeWidgetItem)</dt> +<dd> +reference to the item +</dd> +<dt><i>column</i> (int)</dt> +<dd> +changed column +</dd> +</dl> +<a NAME="TestingWidget.on_discoveryPicker_editTextChanged" ID="TestingWidget.on_discoveryPicker_editTextChanged"></a> +<h4>TestingWidget.on_discoveryPicker_editTextChanged</h4> +<b>on_discoveryPicker_editTextChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the discovery start directory. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +new discovery start directory +</dd> +</dl> <a NAME="TestingWidget.on_frameworkComboBox_currentIndexChanged" ID="TestingWidget.on_frameworkComboBox_currentIndexChanged"></a> <h4>TestingWidget.on_frameworkComboBox_currentIndexChanged</h4> <b>on_frameworkComboBox_currentIndexChanged</b>(<i>index</i>) @@ -845,6 +1081,20 @@ <p> Private slot to show a window containing the list of defined markers. </p> +<a NAME="TestingWidget.on_statusFilterComboBox_currentTextChanged" ID="TestingWidget.on_statusFilterComboBox_currentTextChanged"></a> +<h4>TestingWidget.on_statusFilterComboBox_currentTextChanged</h4> +<b>on_statusFilterComboBox_currentTextChanged</b>(<i>status</i>) + +<p> + Private slot handling the selection of a status for items to be shown. +</p> +<dl> + +<dt><i>status</i> (str)</dt> +<dd> +selected status +</dd> +</dl> <a NAME="TestingWidget.on_testsuitePicker_aboutToShowPathPickerDialog" ID="TestingWidget.on_testsuitePicker_aboutToShowPathPickerDialog"></a> <h4>TestingWidget.on_testsuitePicker_aboutToShowPathPickerDialog</h4> <b>on_testsuitePicker_aboutToShowPathPickerDialog</b>(<i></i>) @@ -920,7 +1170,7 @@ <h3>Class Attributes</h3> <table> -<tr><td>IDLE</td></tr><tr><td>RUNNING</td></tr><tr><td>STOPPED</td></tr> +<tr><td>DISCOVERY</td></tr><tr><td>IDLE</td></tr><tr><td>RUNNING</td></tr><tr><td>STOPPED</td></tr> </table> <h3>Class Methods</h3>