diff --git a/.github/workflows/generate_doc.yml b/.github/workflows/generate_doc.yml index 13df06ce66..037cfeb94f 100644 --- a/.github/workflows/generate_doc.yml +++ b/.github/workflows/generate_doc.yml @@ -24,6 +24,11 @@ jobs: pip install pip --upgrade pip install -r requirements.txt + - name: Generate test report files + working-directory: docs + run: | + python3 tests/test_report_generator.py . ../testing_results/ + - name: Build doc working-directory: docs run: | diff --git a/docs/tests/general/core/add_dev_tests.rst b/docs/tests/general/core/add_dev_tests.rst index dc028294a6..09ce5c485f 100644 --- a/docs/tests/general/core/add_dev_tests.rst +++ b/docs/tests/general/core/add_dev_tests.rst @@ -7,6 +7,22 @@ Add device User guide: :ref:`Scopy Overview `. +.. 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 environment: ------------------ @@ -39,9 +55,27 @@ lists available devices when initiated. - **Expected result:** In the "Context" dropdown, all available devices are listed, each item containing the device name/description and URI. The **ADALM2000** device [usb] must appear in the list. + - **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: Verifying the local device scanning functionality. ---------------------------------------------------------- @@ -65,9 +99,27 @@ lists available local devices when initiated. devices are listed, each item containing the device name/description and URI. If there is no available device the "No scanned devices available!" message 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 3: Verifying the ip device scanning functionality. ------------------------------------------------------- @@ -91,9 +143,27 @@ lists available ip devices when initiated. devices are listed, each item containing the device name/description and URI. If there is no available device the "No scanned devices available!" message 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 4: Verifying the usb device scanning functionality. -------------------------------------------------------- @@ -115,9 +185,27 @@ lists available usb devices when initiated. - **Expected result:** In the "Context" dropdown, all available usb devices are listed, each item containing the device name/description and URI. The **ADALM2000** device must appear in the list. + - **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 5: Verifying the serial device scanning functionality. ----------------------------------------------------------- @@ -142,9 +230,27 @@ lists available serial devices when initiated. devices are listed, each item containing the device name/description and URI. If there is no available device the "No scanned devices available!" message 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 6: Scanning with no device. -------------------------------- @@ -165,9 +271,27 @@ when no device is found. 5. Wait until the refresh animation stops. - **Expected result:** The "No scanned devices available!" message 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). + .. _tst-add-verify: Test 7: Device validation. @@ -192,9 +316,27 @@ Test 7: Device validation. 3. Click on **Verify** button. - **Expected result:** A loading animation starts and after a short time a page with device details and compatible plugins 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 8: Verify the "BACK" button from compatible plugin page. ------------------------------------------------------------- @@ -217,9 +359,27 @@ Test 8: Verify the "BACK" button from compatible plugin page. 3. Click on **Verify** button. 4. Click on **BACK** button. - **Expected result:** The verify page 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). + .. _tst-add-plugins-add: Test 9: Verify the "ADD DEVICE" button from compatible plugin page (single plugin). @@ -245,13 +405,37 @@ Only the main plugin of the device is used. 3. Click on **Verify** button. - **Expected result:** Only the M2kPlugin should be selected in the compatible plugins section. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Click on **ADD DEVICE** button. - **Expected result:** The device is added to the device browser, the device's info page is displayed, and the m2k tools are added to the tool menu. + - **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 10: Verify the "ADD DEVICE" button from compatible plugin page (multiple plugins). --------------------------------------------------------------------------------------- @@ -275,14 +459,38 @@ Multiple plugins are used. 3. Click on **Verify** button. - **Expected result:** Only the M2kPlugin should be selected in the compatible plugins section. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Select the DebuggerPlugin. 5. Click on **ADD DEVICE** button. - **Expected result:** The device is added to the device browser, the device's info page is displayed, and all tools, including the debugger, are added to the tool menu. + - **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 11: Verify the "ADD DEVICE" button from compatible plugin page with no plugin selected. -------------------------------------------------------------------------------------------- @@ -305,9 +513,33 @@ Test 11: Verify the "ADD DEVICE" button from compatible plugin page with no plug 3. Click on **Verify** button. - **Expected result:** Only the M2kPlugin should be selected in the compatible plugins section. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Uncheck the M2kPlugin. 5. Click on **ADD DEVICE** button. - **Expected result:** A NO_PLUGIN device is added in device browser and in tool menu. + - **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 -**Result:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). \ No newline at end of file diff --git a/docs/tests/general/core/connection_tests.rst b/docs/tests/general/core/connection_tests.rst index 4675babbeb..7aa724d8d6 100644 --- a/docs/tests/general/core/connection_tests.rst +++ b/docs/tests/general/core/connection_tests.rst @@ -7,6 +7,22 @@ Connection flow User guide: :ref:`Scopy Overview `. +.. 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 environment: ------------------ @@ -51,9 +67,28 @@ Test 1: Verify the connection flow. appears in the application's status bar. After a while, the connection is established, the status LED turns green, and the tools in the menu become accessible. + - **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: Unplug the device while connecting (AUTO-SCAN). ------------------------------------------------------- @@ -77,9 +112,28 @@ unplugged during the connection process. 2. Click on **Connect** button. 3. Unplug the device while connecting. - **Expected result:** The device is removed from device browser. + - **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 3: Unplug the device while connecting (MANUAL-SCAN). --------------------------------------------------------- @@ -106,9 +160,28 @@ unplugged during the connection process. of the device in the device browser, and when hovered over, the message "The device is not available! Verify the connection!" 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 4: Unplug the device before connecting. -------------------------------------------- @@ -133,9 +206,28 @@ unplugged before the connection process. 3. Click on **Connect** button. - **Expected result:** The connection process starts but does not complete. A warning icon appears in the top-right corner. + - **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 5: Disconnecting a device. ------------------------------- @@ -160,5 +252,23 @@ Test 5: Disconnecting a device. - **Expected result:** The device is disconnected, the **Connect** button appears, the device remains in the device browser, and the tools in the menu are no longer accessible. + - **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 -**Result:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). \ No newline at end of file diff --git a/docs/tests/general/core/dev_tests.rst b/docs/tests/general/core/dev_tests.rst index 16d7744605..6d9629f479 100644 --- a/docs/tests/general/core/dev_tests.rst +++ b/docs/tests/general/core/dev_tests.rst @@ -7,6 +7,22 @@ Device interaction User guide: :ref:`Scopy Overview `. +.. 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 environment: ------------------ @@ -49,9 +65,28 @@ expected action: displaying device details and device tools. info page section, and in the tool menu (on the left), the device is added with a list of available tools (in this form, the tools cannot be accessed). + - **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: Remove a device from device browser. -------------------------------------------- @@ -71,9 +106,28 @@ Test 2: Remove a device from device browser. **Steps:** 1. Click the **Forget** button located at the bottom-right of the device icon. - **Expected result:** The device is removed from device browser. + - **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 3: Remove a device from device browser while it is connected. ------------------------------------------------------------------ @@ -97,9 +151,28 @@ of a connected device. 3. Click the **Forget** button located at the bottom-right of the device icon. - **Expected result:** Initially, the device is disconnected and then successfully removed from the device browser. + - **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 4: Edit the name of the device. ------------------------------------ @@ -125,9 +198,28 @@ Test 4: Edit the name of the device. 5. Press enter. - **Expected result:** The device name changes both in the device browser and in the tool menu. + - **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 5: Select a tool. ---------------------- @@ -153,9 +245,28 @@ Test 5: Select a tool. 4. Click on "Home" menu entry. - **Expected result:** The device page is displayed and the home menu item is highlighted. + - **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). + + .. _tst-dev-detach-tool: Test 6: Detach a tool. @@ -182,15 +293,46 @@ correctly. - **Expected result:** The "Oscilloscope" tool is integrated into a separate window from the application. The window title should be: "Scopy-M2kPlugin-Oscilloscope-ip:127.0.0.1". + + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Close the "Oscilloscope" window. - - **Expected result:** The "Oscilloscope" tool is reintegrated into - the main window. + - **Expected result:** The "Oscilloscope" tool is reintegrated into the main window. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Detach the oscilloscope tool again. 6. Close the application. - **Expected result:** Scopy finished successfully. + - **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 7: Reopen the app with a detached tool. -------------------------------------------- @@ -213,9 +355,28 @@ reconnection. 1. Click on the device icon from device browser. 2. Click on **Connect** button. - **Expected result:** The oscilloscope tool is detached. + - **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 8: Collapse device tools in the tool menu. ----------------------------------------------- @@ -237,11 +398,36 @@ the tool menu. 1. Click on the device icon from device browser. 2. Click on the device header from tool menu. - **Expected result:** The tools collapse. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat 2. - **Expected result:** The tools expand. + - **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). + + .. _tst-dev-multi-conn: Test 9: Connecting to multiple devices. @@ -267,6 +453,12 @@ properly. 1. Click on the emu device icon from device browser. 2. Click on **Connect** button. - **Expected result:** The connection is established successfully. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Click on the usb device icon from device browser. 4. Click on **Connect** button. - **Expected result:** The connection is established successfully, both @@ -275,8 +467,28 @@ properly. tools of each device can be accessed. If the menu contains too many entries, then the scroll bar will become visible. + - **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 10: Resource manager with multiple devices. ------------------------------------------------ @@ -302,14 +514,38 @@ properly. 3. Click on the usb device icon from device browser. 4. Click on **Connect** button. 5. Click on the "Oscilloscope" run button of the emu device in the tool menu. - - **Expected result:** The button changes from stop button to run button - (green color). + - **Expected result:** The button changes from stop button to run button (green color). + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Click on the "Spectrum Analyzer" run button of the usb device in the tool menu. - **Expected result:** The button changes from stop button to run button, and the oscilloscope button (of the emu device) remains the same. + - **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 11: Devices order in device browser. ----------------------------------------- @@ -334,5 +570,23 @@ entered into the device browser. 2. Add the usb device. - **Expected result:** The usb device is on the right side of emu device. + - **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 -**Result:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). \ No newline at end of file diff --git a/docs/tests/general/core/emu_tests.rst b/docs/tests/general/core/emu_tests.rst index 7c698d0f02..1369084572 100644 --- a/docs/tests/general/core/emu_tests.rst +++ b/docs/tests/general/core/emu_tests.rst @@ -7,6 +7,22 @@ EMU User guide: :ref:`Scopy Overview `. +.. 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 + * - + - + - + - + - + .. _tst-emu-en: Test 1: Enable the emulator. @@ -30,9 +46,28 @@ correctly. 5. Click on **Enable** button. - **Expected result:** The IIO device tab is selected, and the URI "ip:127.0.0.1" is entered in the corresponding section. + - **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: EMU is not installed. ----------------------------- @@ -55,9 +90,28 @@ when the IIO emulator is not found. 3. Click on **Emulator** tab. - **Expected result:** All the components are disabled and the message "Can't find iio-emu in the system!" 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 3: Disable the emulator. ----------------------------- @@ -84,9 +138,28 @@ correctly. 7. Click on **Disable** button. - **Expected result:** The fields in this tab become editable, and the **Enable** button appears. + - **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 4: Disable the emulator while the emulated device is connected. -------------------------------------------------------------------- @@ -115,9 +188,28 @@ when an emulated device is connected and the "iio-emu" process is stopped. - **Expected result:** The fields in this tab become editable, and the **Enable** button appears. After a few seconds, the device is disconnected. + - **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 5: Verify adalm2000 emu device. ------------------------------------ @@ -144,9 +236,28 @@ correctly (using adalm2000 device). - **Expected result:** The compatible plugins page opens. The compatible plugins are: M2kPlugin (checked), ADCPlugin, DACPlugin, DataLoggerPlugin, DebuggerPlugin, RegmapPlugin. + - **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 6: Verify pluto emu device. -------------------------------- @@ -173,9 +284,28 @@ correctly (using pluto device). - **Expected result:** The compatible plugins page opens. The compatible plugins are: ADCPlugin (checked), DACPlugin (checked), DataLoggerPlugin (checked), DebuggerPlugin (checked), RegmapPlugin (checked). + - **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 7: Verify pqm emu device. ------------------------------ @@ -202,10 +332,28 @@ correctly (using pqm device). - **Expected result:** The compatible plugins page opens. The compatible plugins are: PQMPlugin (checked), ADCPlugin, DACPlugin, DataLoggerPlugin, DebuggerPlugin. + - **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 8: Verify swiot_config emu device. --------------------------------------- @@ -231,9 +379,28 @@ correctly (using swiot_config device). 6. Click on **Verify** button. - **Expected result:** The compatible plugins page opens. The compatible plugins are: SWIOTPlugin (checked), DataLoggerPlugin, DebuggerPlugin. + - **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 9: Verify swiot_runtime emu device. ---------------------------------------- @@ -260,9 +427,28 @@ correctly (using swiot_runtime device). - **Expected result:** The compatible plugins page opens. The compatible plugins are: SWIOTPlugin (checked), ADCPlugin, DataLoggerPlugin, DebuggerPlugin, RegmapPlugin. + - **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 10: Verify generic emu device. ----------------------------------- @@ -288,5 +474,23 @@ correctly (using generic device). 6. Click on **Verify** button. - **Expected result:** The message **"ip:127.0.0.1" not a valid context!** 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 -**Result:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). diff --git a/docs/tests/general/core/hp_tests.rst b/docs/tests/general/core/hp_tests.rst index 33c97a6eef..9dad28f4c1 100644 --- a/docs/tests/general/core/hp_tests.rst +++ b/docs/tests/general/core/hp_tests.rst @@ -7,6 +7,22 @@ Homepage User guide: :ref:`Scopy Overview `. +.. 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 + * - + - + - + - + - + Test 1: The homepage displays correctly when running the application. --------------------------------------------------------------------- @@ -23,9 +39,28 @@ Test 1: The homepage displays correctly when running the application. 2. Observe the application's behavior. - **Expected result:** The application launches without errors and the home page 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: Verifying the "Add device" (+) button. ---------------------------------------------- @@ -44,9 +79,28 @@ Test 2: Verifying the "Add device" (+) button. 4. Observe the application's behavior. - **Expected result:** The page for adding a new device is displayed in the info page section. + - **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). + + .. _tst-hp-auto-scan-on: Test 3: Verifying the auto-scan feature (ON). @@ -70,9 +124,28 @@ Test 3: Verifying the auto-scan feature (ON). 4. Observe the application's behavior. - **Expected result:** After a short period, the device appears in the device browser section. + - **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). + + .. _tst-hp-auto-scan-off: Test 4: Verifying the auto-scan feature (OFF). @@ -96,9 +169,28 @@ scan is turned off. 4. Observe the application's behavior. - **Expected result:** The device should not be visible in the device browser. + - **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). + + .. _tst-hp-manual-scan: Test 5: Verifying the manual scan feature. @@ -123,9 +215,28 @@ all available devices correctly. 4. Click on the **Scan** button. 5. Observe the application's behavior. - **Expected result:** The device appears in the device browser section. + - **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 6: Navigation using the buttons in the info page. ------------------------------------------------------ @@ -156,8 +267,26 @@ Test 6: Navigation using the buttons in the info page. 8. Click on the left arrow button. - **Expected result:** The device's page is displayed and the device icon is highlighted. + - **Actual result:** + +.. + Actual test result goes here. +.. + +**Tested OS:** -**Result:** PASS/FAIL +.. + 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 7: Auto-scan behavior when the device is unplugged. -------------------------------------------------------- @@ -182,5 +311,23 @@ available devices correctly. 5. Unplug the device. 6. Observe the application's behavior. - **Expected result:** The device is removed from device browser. + - **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 -**Result:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). \ No newline at end of file diff --git a/docs/tests/general/core/install_tests.rst b/docs/tests/general/core/install_tests.rst index 21fed9a4b1..1b4bc96c76 100644 --- a/docs/tests/general/core/install_tests.rst +++ b/docs/tests/general/core/install_tests.rst @@ -3,6 +3,21 @@ Installers =================================== +.. 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 + * - + - + - + - + - Test 1: Check Scopy AppImage x86_64 ------------------------------------ @@ -21,6 +36,12 @@ Linux Operating System with x86_64 architecture. 1. Download Scopy Linux AppImage x86_64 from the `release page `_. 2. Unzip the archive. - **Expected result:** a file named **Scopy-x86_64.AppImage** should be extracted. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Grant execution permission to the file using the terminal. .. code-block:: shell @@ -40,14 +61,44 @@ Linux Operating System with x86_64 architecture. application should be displayed inside the terminal. Inside the application, a window containing the license agreement should appear with 2 buttons "Exit" and "Continue". + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Press "Exit". - **Expected result:** Scopy should gracefully close. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Start again the application, just like in step 4. 7. Press "Continue". - **Expected result:** The window containing the license agreement should close and Scopy should be still running. + - **Actual result:** + +.. + Actual test result goes here. +.. + +**Tested OS:** + +.. + Details about the tested OS goes here. + +**Comments:** -**RESULT:** PASS/FAIL +.. + Any comments about the test goes here. + +**Result:** PASS/FAIL + +.. + The result of the test goes here (PASS/FAIL). Test 2: Check Scopy AppImage arm32 @@ -67,6 +118,12 @@ Linux Operating System with arm32 architecture. 1. Download Scopy Linux AppImage arm32 from the `release page `_. 2. Unzip the archive. - **Expected result:** a file named **Scopy-armhf.AppImage** should be extracted. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Grant execution permission to the file using the terminal. .. code-block:: shell @@ -86,14 +143,45 @@ Linux Operating System with arm32 architecture. application should be displayed inside the terminal. Inside the application, a window containing the license agreement should appear with 2 buttons "Exit" and "Continue". + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Press "Exit". - **Expected result:** Scopy should gracefully close. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Start again the application, just like in step 4. 7. Press "Continue". - **Expected result:** The window containing the license agreement should close and Scopy should be still running. + - **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). -**RESULT:** PASS/FAIL Test 3: Check if Scopy AppImage arm64 opens correctly ------------------------------------------------------- @@ -112,6 +200,12 @@ Linux Operating System with arm64 architecture. 1. Download Scopy Linux AppImage arm64 from the `release page `_. 2. Unzip the archive. - **Expected result:** a file named **Scopy-arm64.AppImage** should be extracted. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Grant execution permission to the file using the terminal. .. code-block:: shell @@ -131,14 +225,45 @@ Linux Operating System with arm64 architecture. application should be displayed inside the terminal. Inside the application, a window containing the license agreement should appear with 2 buttons "Exit" and "Continue". + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Press "Exit". - **Expected result:** Scopy should gracefully close. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Start again the application, just like in step 4. 7. Press "Continue". - **Expected result:** The window containing the license agreement should close and Scopy should be still running. + - **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). -**RESULT:** PASS/FAIL Test 4: Check Scopy macOS @@ -158,25 +283,80 @@ system with an x86_64 architecture. 2. Unzip the archive. - **Expected result:** A DMG file named **Scopy-macos** should be extracted. (the file name will also contain the macOS version and the commit hash) + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Double-click the file. - **Expected result:** A pop-up that contains the Scopy icon will appear + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Install the application by right clicking the file and click on **Open**. - **Expected result:** A error pop-up will appear. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Click on **Cancel** and after that repeat the step 4, right click on the file, and click on **Open**. - - **Expected result** A warning pop-up will appear. Different than + - **Expected result:** A warning pop-up will appear. Different than the first one by including an Open button. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Click on **Open** - **Expected result:** After a while, a window with the GUI of the application should open. Inside the application, a window containing the license agreement should appear with 2 buttons "Exit" and "Continue". + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Press "Exit". - **Expected result:** Scopy should gracefully close. + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Start again the application by right-clicking and click on **Open**. 9. Press "Continue". - **Expected result:** The window containing the license agreement should close and Scopy should be still running. + - **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). -**RESULT:** PASS/FAIL Test 5: Check Scopy Windows installer @@ -197,26 +377,87 @@ system with an x86_64 architecture. - **Expected result:** A window containing the installation wizard should open. It should contain a drop-down menu from which can be selected the language during the installation. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Click on **OK** - **Expected result:** The installer continues with the `License Agreement` tab. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Click on **I accept the agreement** and on **Next**. - **Expected result:** The installer continues with the location where the application will be installed. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Select a location and click on **Next**. - **Expected result:** The installer continues with the list of components that will be installed. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Click on **Next**. - **Expected result:** The installer continues with the `Additional Tasks` tab. + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Check the `"Install drivers for ADALM2000 - Requires Administrative Rights"` box and click on **Next**. - **Expected result:** The installer continues with the installation summary. + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Click on **Install**. - **Expected result:** The application should start installing. At the end of the installation, it should ask for Administrative Rights in order to install ADALM2000 drivers. + - **Actual result:** + +.. + Actual test result goes here. +.. + 9. Inside the newly opened window. Follow the ADALM2000 drivers installation by clicking **Next** and **Finish**. - **Expected result:** Both the application and the ADALM2000 drivers installed successfully. And optionally, you can check to restart the computer or not. + - **Actual result:** + +.. + Actual test result goes here. +.. + 10. Click on **Finish**. -**RESULT:** PASS/FAIL \ No newline at end of file +**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). diff --git a/docs/tests/general/core/license_about_page.rst b/docs/tests/general/core/license_about_page_tests.rst similarity index 68% rename from docs/tests/general/core/license_about_page.rst rename to docs/tests/general/core/license_about_page_tests.rst index ad38d6ced5..a1480cd2d4 100644 --- a/docs/tests/general/core/license_about_page.rst +++ b/docs/tests/general/core/license_about_page_tests.rst @@ -3,6 +3,21 @@ License and About Page ======================================== +.. 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 + * - + - + - + - + - Test 1: Check license pop-up ----------------------------- @@ -20,14 +35,45 @@ Test 1: Check license pop-up 3. Scroll down, click on **Reset** and after that on **Restart** - **Expected result:** The application should restart and the first thing that appears on the screen is a pop-up regarding the license used in Scopy. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Click on the highlighted text **"GPLv3"** - **Expected result:** A web browser window will open containing the GPLv3 license used by Scopy. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Click on **Continue** - **Expected result:** The application will display the home screen with the text "Welcome to Scopy!". + - **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). -**RESULT:** PASS/FAIL Test 2: Check links from About Page @@ -45,31 +91,90 @@ Test 2: Check links from About Page 2. Click on the **About** button from the bottom left side of the application. - **Expected result:** The application will display a screen containing textual information about the current version. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Click on the underlined word **here** from the line **Build info: here** - **Expected result:** The displayed text will change, and it now shows more detailed information about the building process. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Click on the **Home** buttom from the top right side of the application. - **Expected result:** The application will display the initial screen of the About page. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Click on the highlighted text **Scopy open source project** - **Expected result:** The application will display more information about the Scopy project. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Click on the **Home** buttom from the top right side of the application. 7. Click on the highlighted text **other open source software** - **Expected result:** The application will display a list of open source libraries included or linked to Scopy. + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Click on the **Home** buttom from the top right side of the application. 9. Click on the highlighted text **Latest Release** - **Expected result:** A web browser window will open containing the latest release of Scopy. + - **Actual result:** + +.. + Actual test result goes here. +.. + 10. Click on the **Home** buttom from the top right side of the application. 11. Click on the highlighted text **Documentation** - **Expected result:** A web browser window will open containing the documentation for Scopy. + - **Actual result:** + +.. + Actual test result goes here. +.. + 12. Click on the **Home** buttom from the top right side of the application. 13. Click on the highlighted text **Support Forum** - **Expected result:** A web browser window will open containing a forum named `ADI EngineerZone`. + - **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 -**RESULT:** PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). diff --git a/docs/tests/general/general_preferences_tests.rst b/docs/tests/general/general_preferences_tests.rst index f6f7819111..fac202f0bf 100644 --- a/docs/tests/general/general_preferences_tests.rst +++ b/docs/tests/general/general_preferences_tests.rst @@ -3,6 +3,22 @@ General Preferences - Test Suite ================================== +.. 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 environment: ------------------ @@ -51,13 +67,44 @@ states (only applies to plugins which have this implemented). 4. Close Scopy 5. Open the app using the same setup and check if the time base - **Expected result:** time base is 1s + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Redo all the steps with the preference disabled - **Expected result:** time base is the default value + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Press the "Settings file location" open button within the preference menu - - **Expected results:** should open a file browser containing + - **Expected result:** should open a file browser containing .ini files for every plugins' session saved + - **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). -**Result**: PASS/FAIL Test 2 - Double click to attach/detach tool -------------------------------------------------- @@ -80,11 +127,36 @@ double clicking them in the left menu. 1. Set preference to enabled. 2. Double click Oscilloscope tool to detach it. - **Expected result:** Oscilloscope tool should detach from - the main window into a new one. + the main window into a new one. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Redo all the steps with the preference disabled. - - **Expected result:** Nothing should happen. + - **Expected result:** Nothing should happen. + - **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). -**Result**: PASS/FAIL Test 3 - Save/Load tool attached state -------------------------------------------------- @@ -108,11 +180,36 @@ Test 3 - Save/Load tool attached state 2. Double click Oscilloscope tool to detach it. 3. Close Scopy. 4. Open the app using the same setup. - - **Expected result:** Oscilloscope is still detached. + - **Expected result:** Oscilloscope is still detached. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Redo all the steps with the preference disabled. - - **Expected result:** Oscilloscope should not be detached. + - **Expected result:** Oscilloscope should not be detached. + - **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). -**Result**: PASS/FAIL Test 4 - Double click control buttons to open menu -------------------------------------------------- @@ -136,11 +233,36 @@ Test 4 - Double click control buttons to open menu 3. Double click Cursors button in the bottom right ( do not click on the button's icon). - - **Expected result:** A hovering menu should open above the button. + - **Expected result:** A hovering menu should open above the button. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Redo all the steps with the preference disabled. - - **Expected result:** No menu should open. + - **Expected result:** No menu should open. + - **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). -**Result**: PASS/FAIL Test 5 - Enable OpenGL plotting @@ -165,12 +287,37 @@ Test 5 - Enable OpenGL plotting 2. Set Debug preference "Show plot FPS" to enabled. 3. Open Oscilloscope tool and run it. - **Expected result:** The red text inside the plot - should contain "OpenGL rendering." + should contain "OpenGL rendering." + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Redo all the steps with the preference disabled. - **Expected result:** The red text inside the plot - should contain "Software rendering." + should contain "Software rendering." + - **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). -**Result**: PASS/FAIL Test 6 - Enable menu animations -------------------------------------------------- @@ -191,11 +338,36 @@ Test 6 - Enable menu animations **Steps:** 1. Set preference to enabled. 2. Open Oscilloscope tool and toggle between trigger and channel menus. - - **Expected result:** Opening menus should be animated. + - **Expected result:** Opening menus should be animated. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Redo all the steps with the preference disabled. - - **Expected result:** Opening menus shouldn't have any animations. + - **Expected result:** Opening menus shouldn't have any animations. + - **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). -**Result**: PASS/FAIL Test 7 - Enable the status bar for displaying important messages @@ -217,11 +389,36 @@ Test 7 - Enable the status bar for displaying important messages Steps 1. Set preference to enabled. 2. Do the setup again and look for a message bar when pressing "connect." - - **Expected result:** A message about connecting should appear at the bottom of the window. + - **Expected result:** A message about connecting should appear at the bottom of the window. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Redo all the steps with the preference disabled. - - **Expected result:** No message should pop up. + - **Expected result:** No message should pop up. + - **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). -**Result**: PASS/FAIL Test 8 - Show Grid @@ -243,11 +440,36 @@ Test 8 - Show Grid **Steps:** 1. Set preference to enabled. 2. Open ADC - Time tool. - - **Expected result:** A grid should be visible on the plot. - 3. Redo all the steps with the preference disabled. - - **Expected result:** No grid on the plot. + - **Expected result:** A grid should be visible on the plot. + - **Actual result:** + +.. + Actual test result goes here. +.. + + 3. Redo all the steps with the preference disabled. + - **Expected result:** No grid on the plot. + - **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). -**Result**: PASS/FAIL Test 9 - Show Graticule @@ -271,12 +493,37 @@ Test 9 - Show Graticule 2. Open ADC - Time tool. - **Expected result:** A horizontal and a vertical measurement line should be centered on the 0-axis - points (both may not be visible at the same time). - 3. Redo all the steps with the preference disabled. - - **Expected result:** The lines should border the entire - plot instead of centering on 0 points. + points (both may not be visible at the same time). + - **Actual result:** + +.. + Actual test result goes here. +.. + + 3. Redo all the steps with the preference disabled. + - **Expected result:** The lines should border the entire + plot instead of centering on 0 points. + - **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). -**Result**: PASS/FAIL Test 10 - Use Lazy Loading -------------------------------------------------- @@ -298,14 +545,33 @@ Test 10 - Use Lazy Loading 1. Set preference to enabled. 2. Open Scopy console executable. 3. After connecting to Pluto as described in the setup, look - in the console for "device connection took:" times. + in the console for "device connection took:" times. 4. Redo all the steps with the preference disabled and compare the elapsed times. - **Expected result:** Elapsed times connecting to some - plugins should be lower when lazy loading is enabled. + plugins should be lower when lazy loading is enabled. + - **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). -**Result**: PASS/FAIL Test 11 - Use native dialogs ------------------------------- @@ -322,13 +588,38 @@ Test 11 - Use native dialogs **Steps:** 1. Set preference to enabled. 2. Press the Load button on the left menu. - - **Expected result:** A native file browser window should open. + - **Expected result:** A native file browser window should open. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Redo all the steps with the preference disabled. - **Expected result:** A non-native, Scopy-specific, - file browser window should open. + file browser window should open. + - **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 12 - Auto-connect to previous session -------------------------------------------------- @@ -350,12 +641,37 @@ Test 12 - Auto-connect to previous session 2. Connect to the device and then close the application. 3. Open Scopy. - **Expected result:** Scopy should automatically connect - to the Pluto device. - 4. Redo all the steps with the preference disabled. - - **Expected result:** Should not connect automatically. + to the Pluto device. + - **Actual result:** + +.. + Actual test result goes here. +.. + + 4. Redo all the steps with the preference disabled. + - **Expected result:** Should not connect automatically. + - **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 13 - Font scale -------------------------------------------------- @@ -375,12 +691,37 @@ so some layout artifacts may appear). **Steps:** 1. Set preference to 1.45, restart Scopy, and inspect some tools. - - **Expected result:** All app text and some buttons should be larger. + - **Expected result:** All app text and some buttons should be larger. + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Repeat the steps for font size 1. - - **Expected result:** Text should return to default size. + - **Expected result:** Text should return to default size. + - **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 14 - Theme -------------------------------------------------- @@ -402,9 +743,28 @@ Test 14 - Theme 1. Set preference to a different theme and restart the app. - **Expected result:** Themes should change while retaining the same UX and usability in all tools. + - **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 15 - Language -------------------------------------------------- @@ -423,11 +783,30 @@ Test 15 - Language - OS: ANY Steps - 1. Set preference to a different language and restart the app. - - **Expected result:** Some text language should change in the M2K tools. + 1. Set preference to a different language and restart the app. + - **Expected result:** Some text language should change in the M2K tools. + - **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 16 - Connect to multiple devices -------------------------------------------------- @@ -449,12 +828,37 @@ Test 16 - Connect to multiple devices 2. Connect to 2 devices following the setup. - **Expected result:** Two devices should appear in the left menu and be fully functional. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat the steps with the preference disabled. - **Expected result:** When connecting to the second device, - the first one should automatically disconnect. + the first one should automatically disconnect. + - **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 17 - Regularly scan for new devices -------------------------------------------------- @@ -475,13 +879,38 @@ Test 17 - Regularly scan for new devices 1. Connect the Pluto to the machine via USB. - **Expected result:** Pluto should automatically appear in the device list, and a toggle switch for scanning should - appear in the top right. - 2. Repeat the steps with the preference disabled. + appear in the top right. + - **Actual result:** + +.. + Actual test result goes here. +.. + + 2. Repeat the steps with the preference disabled. - **Expected result:** Pluto should not appear automatically, - only when pressing the on-demand Scan button. + only when pressing the on-demand Scan button. + - **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 18 - Session devices -------------------------------------------------- @@ -503,10 +932,29 @@ Test 18 - Session devices "X" button on the device. 4. Close and reopen Scopy. - **Expected result:** Should automatically connect to the URI you - checked. + checked. + - **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 19 - Show plot FPS -------------------------------------------------- @@ -527,12 +975,37 @@ Test 19 - Show plot FPS 1. Open Oscilloscope and run it. 2. Open ADC - Time and run it. - **Expected result:** Should show the FPS on the plot - (M2K may look different from other plugins). + (M2K may look different from other plugins). + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat the steps with the preference disabled. - - **Expected result:** No FPS should be visible. + - **Expected result:** No FPS should be visible. + - **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 20 - Plot target FPS -------------------------------------------------- @@ -553,10 +1026,29 @@ Test 20 - Plot target FPS **Steps:** 1. Set the preference to each value and run ADC - Time to check FPS. - - **Expected result:** Plot FPS should be capped at the selected value. + - **Expected result:** Plot FPS should be capped at the selected value. + - **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 21 - Reset settings and plugins to default -------------------------------------------------- @@ -577,7 +1069,26 @@ Test 21 - Reset settings and plugins to default 1. Change general preferences and M2K preferences. 2. Press the "Restart" button and restart the app. - **Expected result:** All changed preferences should have - the default values. + the default values. + - **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). + + diff --git a/docs/tests/general/index.rst b/docs/tests/general/index.rst index 7237765c23..6f638bc0cd 100644 --- a/docs/tests/general/index.rst +++ b/docs/tests/general/index.rst @@ -11,14 +11,14 @@ Contents :maxdepth: 3 core/hp_tests - core/license_about_page + core/license_about_page_tests core/install_tests core/add_dev_tests core/connection_tests core/emu_tests core/dev_tests - instrument_detaching + instrument_detaching_tests general_preferences_tests .. diff --git a/docs/tests/general/instrument_detaching.rst b/docs/tests/general/instrument_detaching_tests.rst similarity index 84% rename from docs/tests/general/instrument_detaching.rst rename to docs/tests/general/instrument_detaching_tests.rst index 2aa7d74d96..ad7a418165 100644 --- a/docs/tests/general/instrument_detaching.rst +++ b/docs/tests/general/instrument_detaching_tests.rst @@ -1,6 +1,22 @@ Instrument Detaching - Test Suite ==================================================================================================== +.. 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 + * - + - + - + - + - + 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. @@ -31,9 +47,40 @@ Test 1: Detach and reattach an instrument 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. + - **Actual result:** + +.. + Actual test result goes here. +.. + 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. + - **Actual result:** + +.. + Actual test result goes here. +.. + 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. + - **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). + diff --git a/docs/tests/index.rst b/docs/tests/index.rst index 71b0951ead..2fbc88e10d 100644 --- a/docs/tests/index.rst +++ b/docs/tests/index.rst @@ -3,6 +3,11 @@ Test Cases =============================================================================== +Current reports +------------------------ + +.. include:: test_report.rst + Contents --------------------------------------------------------------------- @@ -10,5 +15,6 @@ Contents :includehidden: :maxdepth: 3 + testing_guide plugins/index general/index diff --git a/docs/tests/plugins/adc/adc_tests.rst b/docs/tests/plugins/adc/adc_tests.rst index 001f2f829f..88038e6021 100644 --- a/docs/tests/plugins/adc/adc_tests.rst +++ b/docs/tests/plugins/adc/adc_tests.rst @@ -7,6 +7,22 @@ ADC Plugin - Test Suite User guide: :ref:`ADC user guide` +.. 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 environment ------------------ @@ -60,17 +76,55 @@ Test 1 - X-AXIS 4. Press Single - **Expected result:** Plot labels should go up to 100, and channel curves should span across the whole plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Turn off Sync buffer-plot sizes 6. Set plot size to 200 7. Press Single - **Expected result:** Plot labels should go up to 200, and channel curves should span across the whole plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Turn on Rolling mode - **Expected result:** Plot labels should invert, going from 200 to 0 + - **Actual result:** + +.. + Actual test result goes here. +.. + 9. Change XMin to 200 and XMax to -100 10. Press Single - **Expected result:** Plot labels should range from 300 to -100, with channel curves centered and between samples 200 and 0 + - **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). -**Result**: PASS/FAIL Test 2 - Y-AXIS ^^^^^^^^^^^^^^^ @@ -88,14 +142,40 @@ Test 2 - Y-AXIS 1. Scroll down and turn on plot labels in the settings panel 2. Turn on Autoscale and press Run - **Expected result:** Y-axis should automatically scale according to channel curves + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Press Stop 4. Turn Autoscale off 5. Set YMode to ADC Counts 6. Set Min to -4000 and Max to 4000 7. Press Single - **Expected result:** Y-axis labels should range from -4000 to 4000, and curves should vertically adjust accordingly + - **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). -**Result**: PASS/FAIL Test 3 - XY PLOT @@ -116,17 +196,61 @@ Test 3 - XY PLOT 1. Run Pluto.signalGenerator setup 2. Turn on XY PLOT - **Expected result:** A new plot should appear on the right + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Turn on Autoscale - **Expected result:** On the time plot, both channel curves should look the same, but voltage0 should have a higher amplitude + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Set X Axis source to voltage0 - **Expected result:** A small circular curve should appear on the XY plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Set X Axis source to voltage1 - **Expected result:** A larger circular curve should appear on the XY plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Turn Plot X source on and off - **Expected result:** A line cutting the circle should be visible in a different color + - **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). -**Result**: PASS/FAIL Test 4 - Settings @@ -145,12 +269,44 @@ Test 4 - Settings **Steps:** 1. Change Plot Title to "test" - **Expected result:** text in top left should change to "test" + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Turn on and off plot labels - **Expected result:** labels on x and y axis should appear + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Change thickness and style to all available modes and observe the changes - **Expected result:** channel curves' appearance should behave as expected + - **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). -**Result**: PASS/FAIL Test 5 - Print @@ -173,8 +329,28 @@ Test 5 - Print 4. Select a folder and save the file - **Expected result:** a new PDF file should appear within the folder containing the last view of the plot + - **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). -**Result**: PASS/FAIL Test 6 - Info @@ -193,8 +369,28 @@ Test 6 - Info **Steps:** 1. Press the info button in the top left corner of the window - **Expected result:** this should open the ADC plugin documentation. + - **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). -**Result**: PASS/FAIL Test 7 - Plot Navigation @@ -214,16 +410,60 @@ Test 7 - Plot Navigation 1. Scroll down and turn on plot labels in the settings panel 2. Place mouse cursor within the plot and use the scroll wheel - **Expected result:** should zoom in/out on the area at the cursor, should not be able to zoom out more than the default view + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Right-click the plot after zooming in - **Expected result:** should undo the zoom + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Select an area on the plot using left-click - **Expected result:** should zoom in exactly on the selected area + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Zoom in using the selection method, then hold left shift button and zoom using the scroll wheel - **Expected result:** should pan left and right + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Zoom in using all methods described above and press right-click until zoom is back to default - **Expected result:** should undo each zoom operation one by one + - **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). -**Result**: PASS/FAIL Test 8 - ADC-Time Channel Settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -241,12 +481,38 @@ Test 8 - ADC-Time Channel Settings **Steps:** 1. Double-click on the voltage0 channel and go to the right menu which pops up 2. Enable Y-AXIS and move up and down the axis handle - - **expected result:** this should move the channel curve within the Y-axis + - **Expected result:** this should move the channel curve within the Y-axis + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Turn autoscale off. Set YMode to ADC Counts, Min to -4000 and Max to 4000, and press single - - **expected result:** only voltage0 curve should vertically adjust + - **Expected result:** only voltage0 curve should vertically adjust + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Turn off Y-AXIS -**Result**: PASS/FAIL +**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 9 - Measure @@ -269,12 +535,38 @@ and checking frequency and stats - **Expected result:** check frequency measure and stats in the horizontal measurements table, middle measure and stats in the vertical measurements table. Frequency should be around 1MHz in both panels, middle should be hovering around the 0 value in both panels + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Open the Measure menu and show all Stats and Measurements - **Expected result:** all checkboxes in the measurement tables should be checked and each should have a corresponding label above and below the plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Turn off measurements -**Result**: PASS/FAIL +**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 10 - Cursors @@ -298,18 +590,68 @@ tracking, and moving readouts 4. Open the Cursors menu at the bottom of the window. Enable X and Enable Y 5. Move the X cursors on the plot via the axis handles and place one on voltage0 sine high peak and the other on the next low peak - **Expected result:** delta x should be around 15 samples between voltage0 high peak and low peak + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Lock X cursors via the Cursor menu. Move one cursor to a voltage1 high peak - **Expected result:** the second cursor should move and maintain the same delta. High peak to low peak should match in both voltage0 and voltage1 + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Enable track and select voltage0 - **Expected result:** markers should appear on the voltage0 curve synced with the X cursor. Values in cursor readouts should change accordingly + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Select voltage1 channel - **Expected result:** markers and readouts should now be related to voltage1 + - **Actual result:** + +.. + Actual test result goes here. +.. + 9. Turn off track and measure voltage0 and voltage1 amplitudes - **Expected result:** for voltage0 delta y should be around 1.4kV and for voltage1 500V + - **Actual result:** + +.. + Actual test result goes here. +.. + 10. Enable move readouts. Click and hold the readouts to move them - **Expected result:** should be able to move the readouts anywhere within the plot + - **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). -**Result**: PASS/FAIL .. _adc_frequency_tests: @@ -335,12 +677,44 @@ plotting in the ADC plugin 1. Scroll down and turn on plot labels in the settings panel 2. Set XMode to Samples, buffer size to 4000, and press single - **Expected result:** Plot labels should go up to 4000, and channel curves should span across the whole plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Set XMode to Frequency, XMin to 0.5 MHz, XMax to 2 MHz, and press single - **Expected result:** Plot labels should be from 0.5 MHz to 2 MHz, and channel curves should be centered + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Set frequency offset to 1 MHz and press single - **Expected result:** Curves should move 1 MHz to the left + - **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). -**Result**: PASS/FAIL Test 2 - Y-Axis settings @@ -361,14 +735,52 @@ range settings 1. Scroll down and turn on plot labels in the settings panel 2. Turn on autoscale and press run - **Expected result:** Y-axis should automatically scale according to the channel curves + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Press stop, turn autoscale off, set YMode to ADC Counts, Min to -140, Max to 20, and press single - **Expected result:** Y-axis labels should be from -140 to 20, and curves should vertically adjust + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Set power offset to 20 dB and press single - **Expected result:** Curves should move 20 dB up + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Press run and change through all the window options and window correction - **Expected result:** The curves should change slightly in real time + - **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). -**Result**: PASS/FAIL Test 3 - Settings adjustment @@ -388,12 +800,44 @@ and style **Steps:** 1. Change Plot Title to "test" - **Expected result:** Text in the top left should change to "test" + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Turn on and off plot labels - **Expected result:** Labels on X and Y axis should appear + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Change thickness and style to all available modes and observe the changes - **Expected result:** Channel curves should adjust appearance as expected + - **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). -**Result**: PASS/FAIL Test 4 - Print plot ^^^^^^^^^^^^^^^^^^^ @@ -413,8 +857,28 @@ Test 4 - Print plot 2. Press the single button and then the print button 3. Select a folder and save the file - **Expected result:** A new PDF file should appear in the folder containing the last view of the plot + - **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). -**Result**: PASS/FAIL Test 5 - View plugin documentation @@ -433,8 +897,28 @@ Test 5 - View plugin documentation **Steps:** 1. Press the info button in the top left corner of the window - **Expected result:** The ADC plugin documentation should open + - **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). -**Result**: PASS/FAIL Test 6 - Y-Axis channel settings @@ -453,11 +937,37 @@ Test 6 - Y-Axis channel settings **Steps:** 1. Enable Y-Axis and move the axis handle up and down - **Expected result:** The channel curve should move within the Y-axis + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Turn off autoscale, set YMode to ADC Counts, Min to -140, Max to 20, and press single - **Expected result:** Only the voltage0 curve should vertically adjust + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Turn off Y-Axis -**Result**: PASS/FAIL +**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 7 - Marker settings @@ -478,16 +988,60 @@ Test 7 - Marker settings 2. Press run and enable the marker 3. Set marker type to peak and count to 5 - **Expected result:** 5 markers should appear on voltage0's curve at the highest peaks + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Repeat the process with a count of 7 - **Expected result:** 7 markers should appear on voltage0's curve at the highest peaks + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Check the table below the plot in peak mode - **Expected result:** The highest peak should be at 1 MHz + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Set marker type to fixed and count to 5 - **Expected result:** 5 movable cursors should appear + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Repeat for a count of 7 - **Expected result:** 7 movable cursors should appear + - **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). -**Result**: PASS/FAIL Test 8 - Cursor settings @@ -509,16 +1063,60 @@ Test 8 - Cursor settings 3. Open the Cursors menu and enable X and Y cursors 4. Move the X cursor on the plot and place one on voltage0's highest peak - **Expected result:** The cursor should measure 1 MHz in the readouts + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Enable track and select voltage0 - **Expected result:** Markers should appear on the voltage0 curve, synced with the X cursor + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Select voltage1 channel - **Expected result:** Markers and readouts should now be related to voltage1 + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Turn off track and measure voltage0's highest peak using the Y cursor - **Expected result:** The cursor should measure about -13 dB in the readouts + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Enable move readouts and click and hold the readouts to move them - **Expected result:** Readouts should be movable within the plot + - **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). -**Result**: PASS/FAIL .. _adc_preferences_tests: @@ -544,12 +1142,44 @@ Test 1 - X Scale Position **Steps:** 1. Change Plot X-Axis scale position to Top, restart app, open ADC-Time and enable plot labels in SETTINGS panel - **Expected result:** Axis labels should appear on top + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for Bottom option - **Expected result:** Axis labels should appear on the bottom + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat for ADC-Frequency - **Expected result:** Same result for ADC-Frequency + - **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). -**Result**: PASS/FAIL Test 2 - Y Scale Position ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -571,12 +1201,44 @@ position on the plot **Steps:** 1. Change Plot Y-Axis scale position to Right, restart app, open ADC-Time and enable plot labels in SETTINGS panel - **Expected result:** Axis labels should appear on the right + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for Left option - **Expected result:** Axis labels should appear on the left + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat for ADC-Frequency - **Expected result:** Same result for ADC-Frequency + - **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). -**Result**: PASS/FAIL Test 3 - Channel Handle Position ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -599,12 +1261,44 @@ Test 3 - Channel Handle Position ADC-Time, double click voltage0 to open channel settings and enable Y-AXIS - **Expected result:** Axis handle should appear on the right + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for Left option - **Expected result:** Axis handle should appear on the left + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat for ADC-Frequency - **Expected result:** Same result for ADC-Frequency + - **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). -**Result**: PASS/FAIL Test 4 - X Cursor Position ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -625,12 +1319,44 @@ Test 4 - X Cursor Position **Steps:** 1. Change Plot X-Cursor position to Top, restart app, open ADC-Time and enable x cursors - **Expected result:** X cursor handle should appear on top + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for Bottom option - **Expected result:** X cursor handle should appear on the bottom + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat for ADC-Frequency - **Expected result:** Same result for ADC-Frequency + - **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). -**Result**: PASS/FAIL Test 5 - Y Cursor Position @@ -652,12 +1378,44 @@ Test 5 - Y Cursor Position **Steps:** 1. Change Plot Y-Cursor position to Right, restart app, open ADC-Time and enable y cursors - **Expected result:** Y cursor handle should appear on the right + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for Left option - **Expected result:** Y cursor handle should appear on the left + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Repeat for ADC-Frequency - **Expected result:** Same result for ADC-Frequency + - **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). -**Result**: PASS/FAIL Test 6 - Show Buffer @@ -679,10 +1437,36 @@ Test 6 - Show Buffer **Steps:** 1. Set buffer to disabled, open ADC-Time - **Expected result:** There should be no buffer previewer above the plot + - **Actual result:** + +.. + Actual test result goes here. +.. + 2. Do this again for the enabled option - **Expected result:** Buffer previewer should appear above the plot + - **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). -**Result**: PASS/FAIL Test 7 - Default YMode @@ -704,5 +1488,24 @@ Test 7 - Default YMode **Steps:** 1. Set YMode to % Full scale, restart app, open ADC-Time - **Expected result:** In Y-AXIS, YMODE should be % Full scale + - **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 -**Result**: PASS/FAIL \ No newline at end of file +.. + The result of the test goes here (PASS/FAIL). diff --git a/docs/tests/plugins/adc/index.rst b/docs/tests/plugins/adc/index.rst new file mode 100644 index 0000000000..567f62fdf8 --- /dev/null +++ b/docs/tests/plugins/adc/index.rst @@ -0,0 +1,13 @@ +.. _tests_adc: + +ADC +=============================================================================== + +Contents +--------------------------------------------------------------------- + +.. toctree:: + :includehidden: + :maxdepth: 3 + + adc_tests diff --git a/docs/tests/plugins/dac/dac_tests.rst b/docs/tests/plugins/dac/dac_tests.rst index 3b14e8b311..0d2b1156d3 100644 --- a/docs/tests/plugins/dac/dac_tests.rst +++ b/docs/tests/plugins/dac/dac_tests.rst @@ -12,6 +12,23 @@ The DAC plugin tests are a set of tests that are run to verify the DAC plugin in The following apply for all the test cases in this suite. If the test case has special requirements, they will be listed in the test case section. + +.. 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 environment: ------------------- @@ -56,11 +73,37 @@ and that the plugin is able to correctly parse it. 2. Switch the "Mode" to "Buffer" and check the "Channels" list: - **Expected result:** The channels list contains the following: **cf-ad9361-dds-core-lpc:voltage0** and **cf-ad9361-dds-core-lpc:voltage1**. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Switch the "Mode" to "DDS" and check the TX section: - **Expected result:** The TX section contains one entry with "TX1". + - **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 - Buffer mode file loading ---------------------------------------------------- @@ -91,6 +134,12 @@ Test 2 - Buffer mode file loading - A new section called "DATA CONFIGURATION" should appear. - The bottom log section contains the following entry structure: *[timestamp] Successfully loaded: [file name]*. + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Select the *tutorial_chapters.json* file from the resources provided above using the "Browse" button. 6. Press the "Load" button. @@ -99,9 +148,29 @@ Test 2 - Buffer mode file loading - The Run button is disabled. - The bottom log section contains the following entry structure: *[timestamp] Failed to load: [file name]*. + - **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 3 - Buffer mode channel selection ---------------------------------------------------- @@ -126,24 +195,62 @@ Test 3 - Buffer mode channel selection 4. Press the "Load" button. 5. Check the channels list for enabled channels: - **Expected result:** Both channels are enabled. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Press "Run". - **Expected result:** - The "Run" button changes to "Stop". - The bottom log section contains the following entry structure: *[timestamp] Pushed 40000 samples, 160000 bytes (1/1 buffers).* + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. While the plugin is running, disable one of the channels. - **Expected result:** - The plugin keeps running. - The bottom log section contains the following entry structure: *[timestamp] Pushed 40000 samples, 80000 bytes (1/1 buffers).* + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. While the plugin is still running, disable the other channel. - **Expected result:** - The plugin stops running and the button change back to "Run". - The bottom log section contains the following entry structure: *[timestamp] Unable to create buffer, no channel enabled.* + - **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 4 - Buffer mode file size validation --------------------------------------------------------- @@ -169,18 +276,62 @@ size in buffer mode. 4. Press the "Load" button. 5. Check the "File Size" field. - **Expected result:** The "File Size" field is populated with **40 ksamples**. + - **Actual result:** + +.. + Actual test result goes here. +.. + 6. Change the "File Size" field to a value higher than the actual file size (write 50 and press Enter). - **Expected result:** The field value remains 40 ksamples since that's the maximum number of samples in the file. + - **Actual result:** + +.. + Actual test result goes here. +.. + 7. Change the "File Size" field to a value lower than the actual file size (write 30 and press Enter). - **Expected result:** The field value changes to 30 ksamples. + - **Actual result:** + +.. + Actual test result goes here. +.. + 8. Change the "File Size" using the "+" button. - **Expected result:** The field value changes to the 31. + - **Actual result:** + +.. + Actual test result goes here. +.. + 9. Change the "File Size" using the "-" button. - **Expected result:** The field value changes to the 30. + - **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 5 - Cyclic buffer mode --------------------------------------------- @@ -217,11 +368,37 @@ Test 5 - Cyclic buffer mode 10. Press "Run". 11. Check the ADC plugin for the generated signal. - **Expected result:** A sinewave is seen on the ADC plot. + - **Actual result:** + +.. + Actual test result goes here. +.. + 12. Stop the DAC plugin while monitoring the ADC plot. - **Expected result:** The sinewave no longer appears. + - **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 6 - DDS modes ---------------------------------- @@ -246,17 +423,49 @@ Test 6 - DDS modes - **scale**: -Inf db - **phase**: 90 - the channel name: "Tone 1 - TX1_I_F1" + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Change the "DDS Mode" to **Two CW Tones**. - **Expected result:** - Two configuration panels appear having the same fields as in the previous step. - The second channel name: "Tone 2 - TX1_I_F2" + - **Actual result:** + +.. + Actual test result goes here. +.. + 5. Change the "DDS Mode" to **Independent I/Q Control**. - **Expected result:** - Four configuration panels appear having the same fields as in the previous step. - The third channel name: "Tone 1 - TX1_Q_F1" - The fourth channel name: "Tone 2 - TX1_Q_F2" + - **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). -**Result**: PASS/FAIL Test 7 - DDS mode sinewave generation ------------------------------------------------------ @@ -294,11 +503,37 @@ Test 7 - DDS mode sinewave generation - **Expected result:** - A sinewave should be seen on the ADC plot. - The measurements show a frequency of 1 MHz. + - **Actual result:** + +.. + Actual test result goes here. +.. + 12. In the DAC plugin change the "DDS Mode" to **Disabled**. - **Expected result:** The sinewave no longer appears on the ADC plot. + - **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 8 - DDS mode attributes refresh ----------------------------------------------------- @@ -325,9 +560,29 @@ Test 8 - DDS mode attributes refresh for the **altvoltage0 TX1_I_F1** to 2000000. 7. Go to the DAC Plugin and click the refresh attributes button. - **Expected result:** The frequency field is updated to 2 MHz. + - **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 9 - Plugin tutorial --------------------------------- @@ -347,14 +602,46 @@ Test 9 - Plugin tutorial 2. Click the "Info" button. - **Expected result:** A pop-up window with 2 buttons (Tutorial and Documentation) should appear. + - **Actual result:** + +.. + Actual test result goes here. +.. + 3. Click the "Documentation" button. - **Expected result:** The documentation page opens in the default browser. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Click the "Tutorial" button. - **Expected result:** - The tutorial opens as a walkthrough in the plugin. + - **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 10 - Channel attributes -------------------------------------------- @@ -373,8 +660,34 @@ Test 10 - Channel attributes 2. Switch the "Mode" to "Buffer". 3. In the "Channels" panel click on the first channel "cf-ad9361-dds-core-lpc:voltage0". - **Expected result:** The channel attributes are displayed in the right side menu. + - **Actual result:** + +.. + Actual test result goes here. +.. + 4. Change the **sampling_frequency** attribute to 38400000. - **Expected result:** The attribute is updated successfully. + - **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). + + diff --git a/docs/tests/plugins/dac/index.rst b/docs/tests/plugins/dac/index.rst new file mode 100644 index 0000000000..de2d1ccc00 --- /dev/null +++ b/docs/tests/plugins/dac/index.rst @@ -0,0 +1,13 @@ +.. _tests_dac: + +DAC +=============================================================================== + +Contents +--------------------------------------------------------------------- + +.. toctree:: + :includehidden: + :maxdepth: 3 + + dac_tests diff --git a/docs/tests/plugins/datalogger/datalogger_test.rst b/docs/tests/plugins/datalogger/datalogger_tests.rst similarity index 65% rename from docs/tests/plugins/datalogger/datalogger_test.rst rename to docs/tests/plugins/datalogger/datalogger_tests.rst index 4323e6aee2..f437a75726 100644 --- a/docs/tests/plugins/datalogger/datalogger_test.rst +++ b/docs/tests/plugins/datalogger/datalogger_tests.rst @@ -14,6 +14,22 @@ The following apply to all tests below, any special requirements will be mention - Tests listed as dependencies are successfully completed - Reset .ini files to default by pressing **Reset** button in Preferences +.. 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 Environment ------------------ @@ -57,15 +73,37 @@ Test 1: Enable and Disable Data Logger Channel 2. Using channel menu enable channel **voltage0** of **xadc** device 3. Press **Run** button 4. Wait for some data to be collected + - **Expected result:** Curve will be displayed on the plot + - **Actual result:** + +.. + Actual test result goes here. +.. - - **Expected result:** Curve will be displayed on the plot - 5. Using channel menu disable channel **voltage0** of **xadc** device + - **Expected result:** Curve will be removed from the plot + - **Actual result:** + +.. + Actual test result goes here. +.. - - **Expected result:** Curve will be removed from the plot +**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). + + .. _TST_DATALOGGER_RUN_STOP_DATA_LOGGING: Test 2: Run and Stop Data Logging @@ -88,21 +126,41 @@ Test 2: Run and Stop Data Logging 1. Open Data Logger plugin 2. Using channel menu enable channel **voltage0** of **xadc** device 3. Press **Run** button + - **Expected result:** + - Data is being collected and displayed on the plot + - **Run** button is changed to **Stop** + - **Actual result:** - - **Expected result:** - - - Data is being collected and displayed on the plot - - **Run** button is changed to **Stop** +.. + Actual test result goes here. +.. 4. Press **Stop** button + - **Expected result:** + - Data is no longer being collected and displayed on the plot + - **Stop** button is changed to **Run** + - **Actual result:** + +.. + Actual test result goes here. +.. - - **Expected result:** - - - Data is no longer being collected and displayed on the plot - - **Stop** button is changed to **Run** +**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). + + .. _TST_DATALOGGER_CLEAR_COLLECTED_DATA: Test 3: Clear Collected Data @@ -128,11 +186,30 @@ Test 3: Clear Collected Data 4. Wait for some data to be collected 5. Press **Stop** button 6. Press **Clear** button + - **Expected result:** Data is removed from the plot + - **Actual result:** + +.. + Actual test result goes here. +.. + + +**Tested OS:** - - **Expected result:** Data is removed from the plot +.. + 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). + + .. _TST_DATALOGGER_CLEAR_DATA_WHILE_RUNNING: Test 4: Clear data while running @@ -157,14 +234,31 @@ Test 4: Clear data while running 3. Press **Run** button 4. Wait for some data to be collected 5. Press **Clear** button + - **Expected result:** + - Data is removed from the plot + - Buffer is cleared and the starting point is reset to "0" + - **Actual result:** + +.. + Actual test result goes here. +.. + +**Tested OS:** + +.. + Details about the tested OS goes here. - - **Expected result:** - - - Data is removed from the plot - - Buffer is cleared and the starting point is reset to "0" +**Comments:** + +.. + Any comments about the test goes here. **Result:** PASS/FAIL +.. + The result of the test goes here (PASS/FAIL). + + .. _TST_DATALOGGER_CREATE_NEW_DATA_LOGGER_TOOL: Test 5: Create a New Data Logger Tool @@ -183,14 +277,33 @@ Test 5: Create a New Data Logger Tool **Steps:** 1. Open Data Logger plugin 2. Press **+** button + - **Expected result:** + - New tool is created + - We are moved to the new tool + - The new tool has **x** button next to **+** + + - **Actual result:** + +.. + Actual test result goes here. +.. + +**Tested OS:** - - **Expected result:** - - New tool is created - - We are moved to the new tool - - The new tool has **x** button next to **+** +.. + 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). + + .. _TST_DATALOGGER_REMOVE_A_CREATED_TOOL: Test 6: Remove a Created Tool @@ -213,11 +326,30 @@ Test 6: Remove a Created Tool 1. Open Data Logger plugin 2. Press **+** button 3. Press **x** button next to **+** + - **Expected result:** Tool is removed + - **Actual result:** - - **Expected result:** Tool is removed +.. + 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). + + .. _TST_DATALOGGER_VERIFY_REMOVAL_DISABLED_FOR_DEFAULT_TOOL: Test 7: Verify Removal Disabled for Default Tool @@ -236,15 +368,39 @@ Test 7: Verify Removal Disabled for Default Tool **Steps:** 1. Open Data Logger plugin 2. Press **+** button + - **Expected result:** A new tool where **x** button is available is created + - **Actual result:** + +.. + Actual test result goes here. +.. - - **Expected result:** A new tool where **x** button is available is created 3. Open original Data Logger tool + - **Expected result:** No **x** button is available + - **Actual result:** + +.. + Actual test result goes here. +.. + + +**Tested OS:** - - **Expected result:** No **x** button is available +.. + 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). + + .. _TST_DATALOGGER_PRINT_COLLECTED_DATA: Test 8: Print Collected Data @@ -269,15 +425,32 @@ Test 8: Print Collected Data 3. Press **Run** button 4. Wait for some data to be collected 5. Press **Print** button - 6. Chose directory where to save the file - + 6. Choose directory where to save the file - **Expected result:** - - Data is saved to a pdf file in the chosen directory - The file name structure is "Sopy-Data-Logger--