docs/tests: add test report structure to pqm, swiot, debugger, datalo…

…gger and regmap. Signed-off-by: AlexandraTrifan <[email protected]>
analogdevicesinc · Feb 5, 2025 · c9dca49 · c9dca49
1 parent dc5859b
commit c9dca49
Show file tree

Hide file tree

Showing 9 changed files with 4,600 additions and 222 deletions.
diff --git a/docs/tests/plugins/adc/adc_tests.rst b/docs/tests/plugins/adc/adc_tests.rst
diff --git a/docs/tests/plugins/dac/dac_tests.rst b/docs/tests/plugins/dac/dac_tests.rst
diff --git a/...ts/plugins/datalogger/datalogger_test.rst → ...s/plugins/datalogger/datalogger_tests.rst b/...ts/plugins/datalogger/datalogger_test.rst → ...s/plugins/datalogger/datalogger_tests.rst
diff --git a/docs/tests/plugins/debugger/debugger_preferences_tests.rst b/docs/tests/plugins/debugger/debugger_preferences_tests.rst
@@ -3,6 +3,22 @@ Debugger Preferences - Test Suite
 
 General Description: Debugger preferences are settings that control the behavior of the debugger instrument. You can access the debugger preferences by going to the Preferences page (lower left corner, above the Analog Devices logo and the About button). From there, select the Debugger Plugin from the right-hand side menu. The debugger instrument preferences are:
 
+.. note::
+    .. list-table:: 
+       :widths: 50 30 30 50 50
+       :header-rows: 1
+
+       * - Tester
+         - Test Date
+         - Scopy version
+         - Plugin version (N/A if not applicable)
+         - Comments
+       * - 
+         - 
+         - 
+         - 
+         - 
+
 Setup enviroment:
 ----------------------------------------------------------------------------------------------------------------------------
 
@@ -27,17 +43,60 @@ Test 1: Control debugger version
 **Steps**:
         1. Click on the connected Pluto device and connect to it. Select the Debugger plugin. By default, the IIO Explorer (Debugger v2) should be displayed.
                 - **Expected Result:** The IIO Explorer (Debugger v2) should be displayed. If you notice the navigation bar with devices and attributes on the left side, the IIO Explorer is displayed.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
         2. Go to the Preferences page (lower left corner, above the Analog Devices logo and the About button). From there, select the Debugger Plugin from the right-hand side menu. Uncheck the "Use debugger V2 plugin" option.
                 - **Expected Result:** A 'Restart' button should appear at the bottom of the preferences page. Click on the 'Restart' button. Scopy should restart.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
         3. Click on the connected Pluto device and connect to it. Select the Debugger plugin.
                 - **Expected Result:** The Debugger v1 plugin should be displayed. If you notice 2 sections, 'DEVICE SELECTION' and 'REGISTER MAP SETTINGS', the Debugger v1 plugin is displayed.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
         4. Repeat step 2, but this time check the "Use debugger V2 plugin" option.
                 - **Expected Result:** A 'Restart' button should appear at the bottom of the preferences page. Click on the 'Restart' button. Scopy should restart.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
         5. Click on the connected Pluto device and connect to it. Select the Debugger plugin.
                 - **Expected Result:** The IIO Explorer (Debugger v2) should be displayed. If you notice the navigation bar with devices and attributes on the left side, the IIO Explorer is displayed.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
+**Tested OS:**
+
+..
+  Details about the tested OS goes here.
+
+**Comments:**
+
+..
+  Any comments about the test goes here.
 
 **Result:** PASS/FAIL
 
+..
+  The result of the test goes here (PASS/FAIL).
+
+
 Test 2: Include debug attributes in IIO Explorer
 ----------------------------------------------------------------------------------------------------
 
@@ -57,10 +116,36 @@ Test 2: Include debug attributes in IIO Explorer
         2. Go to the Preferences page (lower left corner, above the Analog Devices logo and the About button). From there, select the Debugger Plugin from the right-hand side menu. Check the "Include debug attributes in IIO Explorer" option. (if it is checked, leave it as it is)
         3. Go back to the Debugger plugin and notice the navigation bar on the left side. Double click on ad9361-phy and scroll down a bit.
                 - **Expected Result:** Among the final device attributes of the ad9361-phy device, you should see the debug attributes. They should start with the 'adi,' prefix.
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
         4. Go back to the Preferences page and uncheck the "Include debug attributes in IIO Explorer" option.
         5. Restart Scopy.
         6. Click on the connected Pluto device and connect to it. Select the Debugger plugin.
         7. Look at the navigation bar on the left side. Double click on ad9361-phy and scroll down a bit.
                 - **Expected Result:** The debug attributes should not be displayed among the final device attributes of the ad9361-phy device. (i.e., no attributes should start with the 'adi,' prefix)
+                - **Actual result:**
+
+..
+        Actual test result goes here.
+..
+
+
+**Tested OS:**
+
+..
+  Details about the tested OS goes here.
+
+**Comments:**
+
+..
+  Any comments about the test goes here.
 
 **Result:** PASS/FAIL
+
+..
+  The result of the test goes here (PASS/FAIL).
+