Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/tests: multiple fixes in order to align with the test report structure. #1891

Merged
merged 7 commits into from
Feb 5, 2025
Merged

docs/tests: multiple fixes in order to align with the test report structure. #1891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b060310
docs/tests: rename tests and add missing information to all tests
AlexandraTrifan Jan 30, 2025
30e8887
docs/tests: add test report structure to all the general module tests.
AlexandraTrifan Jan 30, 2025
c9a3f08
docs/tests: add test report structure to pqm, swiot, debugger, datalo…
AlexandraTrifan Jan 31, 2025
5e2e99c
docs/tests: add test report structure to the M2K plugin tests.
AlexandraTrifan Jan 31, 2025
c00287c
tests: reorganize the docs/tests folders and add index for each module.
AlexandraTrifan Feb 3, 2025
e55ef33
docs/tests: add a testing guidelines document with detailed steps
AlexandraTrifan Feb 3, 2025
497cfbd
docs: generate tests reports in CI, based on all versions tested
AlexandraTrifan Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/generate_doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
234 changes: 233 additions & 1 deletion docs/tests/general/core/add_dev_tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ Add device

User guide: :ref:`Scopy Overview <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:
------------------

Expand Down Expand Up @@ -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.
----------------------------------------------------------

Expand All @@ -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.
-------------------------------------------------------

Expand All @@ -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.
--------------------------------------------------------

Expand All @@ -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.
-----------------------------------------------------------

Expand All @@ -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.
--------------------------------

Expand All @@ -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.
Expand All @@ -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.
-------------------------------------------------------------

Expand All @@ -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).
Expand All @@ -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).
---------------------------------------------------------------------------------------

Expand All @@ -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.
--------------------------------------------------------------------------------------------

Expand All @@ -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
..
The result of the test goes here (PASS/FAIL).
Loading
Loading