docs/tests: Modify the test case structure

Signed-off-by: Andrei-Fabian-Pop <[email protected]>
analogdevicesinc · Jan 21, 2025 · c6112dc · c6112dc
1 parent 2fa5048
commit c6112dc
Show file tree

Hide file tree

Showing 10 changed files with 1,335 additions and 1,310 deletions.
diff --git a/docs/tests/general/instrument_detaching.rst b/docs/tests/general/instrument_detaching.rst
@@ -5,27 +5,34 @@ General Description:
         - The instrument detaching is the process of removing the instrument from the main window. This is usually done by double clicking the tool name from the tool menu (left side of scopy). The instrument detaching is useful when the user has multiple screens and wants to observe multiple instruments at the same time. The user can detach the instrument from the main window and move it to another screen or another part of the same screen. This feature is not available on Android. Any detached windows will be closed when the main window is closed.
         - When detaching a window, the title bar will include the name of the detached instrument. The user can reattach the instrument either by clicking the X button from the detached window title bar or by double clicking the tool name from the tool menu. The minimize and maximize buttons are also available on the detached window title bar and should work as expected. When reattaching the instrument, the reattached instrument will be the one currently selected. The user can detach multiple instruments at the same time. The detached instruments will be displayed in the order they were detached. Every detached instrument will work exactly as if they were still attached to the main window. The user can detach any instrument that is not the last instrument in the main window. When restarting Scopy, all detached instruments will be detached, just like in the previous session.
 
-Setup:
-        - Pluto.*
+Setup enviroment:
+----------------------------------------------------------------------------------------------------------------------------
+
+.. _pluto-usb-instrument-detaching:
+
+**Pluto.Usb:**
+        - Open the Scopy application
+        - Connect the PlutoSDR to the computer via USB
+        - Type the URI of the PlutoSDR in the URI field (if you don't know the URI, just type "ip:192.168.2.1")
 
 Test 1: Detach and reattach an instrument
 ----------------------------------------------------------------------------------------------------
 
-UID:
-        - TST.GEN.INST.DETACH_REATTACH
+**UID:** TST.GEN.INST.DETACH_REATTACH
 
-Description:
-        - This test checks if the user can detach and reattach an instrument from the main window. The user can detach the instrument by double clicking the tool name from the tool menu (left side of scopy). The user can reattach the instrument either by clicking the X button from the detached window title bar or by double clicking the tool name from the tool menu. The minimize and maximize buttons are also available on the detached window title bar and should work as expected. When reattaching the instrument, the reattached instrument will be the one currently selected.
+**Description:** This test checks if the user can detach and reattach an instrument from the main window. The user can detach the instrument by double clicking the tool name from the tool menu (left side of scopy). The user can reattach the instrument either by clicking the X button from the detached window title bar or by double clicking the tool name from the tool menu. The minimize and maximize buttons are also available on the detached window title bar and should work as expected. When reattaching the instrument, the reattached instrument will be the one currently selected.
 
-OS:
-        - Windows, Linux, Macos
+**Preconditions:**
+        - Scopy is installed on the system.
+        - Windows, Linux-x86_64, Linux-arm64, Linux-arm32, macOS.
+        - Use :ref: `pluto-usb-instrument-detaching <pluto-usb-instrument-detaching>` setup.
 
-Steps:
-        * Step 1: Click on the connected Pluto device and connect to it. Select the 'ADC - Time' plugin.
-        * Step 2: Double click the 'ADC - Time' tool name from the tool menu.
-                * Expected Result: The 'ADC - Time' instrument should be detached from the main window. The title bar of the detached window should include the name of the detached instrument.
-        * Step 3: Click the square button from the tool menu to start the ADC data aquisition.
-                * Expected Result: The ADC should start acquiring data. The data should be displayed in the detached window.
-        * Step 4: Click the X button from the detached window title bar.
-                * Expected Result: The 'ADC - Time' instrument should be reattached to the main window. The 'ADC - Time' instrument should be the one currently selected.
+**Steps:**
+        1. Click on the connected Pluto device and connect to it. Select the 'ADC - Time' plugin.
+        2. Double click the 'ADC - Time' tool name from the tool menu.
+                - **Expected Result:** The 'ADC - Time' instrument should be detached from the main window. The title bar of the detached window should include the name of the detached instrument.
+        3. Click the square button from the tool menu to start the ADC data aquisition.
+                - **Expected Result:** The ADC should start acquiring data. The data should be displayed in the detached window.
+        4. Click the X button from the detached window title bar.
+                - **Expected Result:** The 'ADC - Time' instrument should be reattached to the main window. The 'ADC - Time' instrument should be the one currently selected.
 
diff --git a/docs/tests/plugins/debugger/debugger_preferences.rst b/docs/tests/plugins/debugger/debugger_preferences.rst
diff --git a/docs/tests/plugins/debugger/debugger_preferences_tests.rst b/docs/tests/plugins/debugger/debugger_preferences_tests.rst
@@ -0,0 +1,63 @@
+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:
+
+Setup enviroment:
+----------------------------------------------------------------------------------------------------------------------------
+
+.. _pluto-usb:
+
+**Pluto.Usb:**
+        - Open the Scopy application
+        - Connect the PlutoSDR to the computer via USB
+        - Type the URI of the PlutoSDR in the URI field (if you don't know the URI, just type "ip:192.168.2.1")
+
+Test 1: Control debugger version
+----------------------------------------------------------------------------------------------------
+
+**UID**: TST.DBG.PREF.CHANGE_VERSION
+
+**Description**: This option allows you to use the new debugger plugin. The new plugin is more stable and has more features than the old plugin. The old plugin is still available for use, but it is recommended to use the new plugin. When this option is checked, the new plugin is used. When it is unchecked, the old plugin is used. After changing this option, a restart of Scopy is required for the change to take effect.
+
+**Preconditions**:
+        - Use :ref: `pluto-usb <pluto-usb>` setup.
+        - OS: ANY
+
+**Step**:
+        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.
+        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.
+        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.
+        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.
+        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.
+
+Test 2: Include debug attributes in IIO Explorer
+----------------------------------------------------------------------------------------------------
+
+**UID**:
+        - TST.DBG.PREF.INCLUDE_DEBUG_ATTRIBUTES
+
+**Description**: This option allows you to include IIO debug attributes in the IIO Explorer. When this option is checked, debug attributes are included in the IIO Explorer. When it is unchecked, debug attributes are not included in the IIO Explorer. After changing this option, a restart of Scopy is required for the change to take effect.
+
+Test prerequisites:
+        - :ref: `TST.DBG.EXPLR.NAV <tst-dbg-explr-nav>`
+
+**Preconditions**:
+        - Use :ref: `pluto-usb <pluto-usb>` setup.
+        - OS: ANY
+
+**Step**:
+        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.
+        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.
+        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)