diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75246aaf74..edcb05732a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ Create and activate the Python virtual environment: ``` bash $ cd ~/checkbox/checkbox-ng $ ./mk-venv -$ . ~/checkbox-ng/venv/bin/activate +$ . ~/checkbox/checkbox-ng/venv/bin/activate ``` Activate the base providers in the virtual environment from within the virtual diff --git a/docs/_images/checkbox-tutorial-test-report.png b/docs/_images/checkbox-tutorial-test-report.png new file mode 100644 index 0000000000..e9ca9173ae Binary files /dev/null and b/docs/_images/checkbox-tutorial-test-report.png differ diff --git a/docs/tutorial/using-checkbox/launcher.rst b/docs/tutorial/using-checkbox/launcher.rst index 8910e6dd56..5649ea5a56 100644 --- a/docs/tutorial/using-checkbox/launcher.rst +++ b/docs/tutorial/using-checkbox/launcher.rst @@ -215,7 +215,7 @@ in it: stock_reports = text, submission_files [test plan] - unit = com.canonical.certification::TODO + unit = com.canonical.certification::tutorial-base forced = yes [test selection] @@ -261,7 +261,7 @@ and where it comes from. Run the following command: [test plan] filter=* (Default) forced=True From config file: /home/user/.config/checkbox.conf - unit=com.canonical.certification::TODO From config file: /home/user/.config/checkbox.conf + unit=com.canonical.certification::tutorial-base From config file: /home/user/.config/checkbox.conf [test selection] exclude= (Default) forced=True From config file: /home/user/.config/checkbox.conf diff --git a/docs/tutorial/using-checkbox/running-checkbox.rst b/docs/tutorial/using-checkbox/running-checkbox.rst index 82224fc98b..76c9052714 100644 --- a/docs/tutorial/using-checkbox/running-checkbox.rst +++ b/docs/tutorial/using-checkbox/running-checkbox.rst @@ -393,13 +393,16 @@ Under the summary, you can see 3 additional lines: .. code-block:: none - file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.html - file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.junit.xml - file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.tar.xz + file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.html + file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.junit.xml + file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.tar.xz These are the test reports and submission archives generated by Checkbox for this run. +You will also be asked if you want to submit the report. You can mark `no` for +the moment by pressing ``n`` and then hitting ``Enter``. + As text summary only provides an overview, for more in-depth information, you will need to review submission files (the files such as ``submission_2023-09-06T03.33.14.551448.tar.xz`` in the output above). diff --git a/docs/tutorial/using-checkbox/test-report.rst b/docs/tutorial/using-checkbox/test-report.rst index 5c05cb5d0f..4275a56acd 100644 --- a/docs/tutorial/using-checkbox/test-report.rst +++ b/docs/tutorial/using-checkbox/test-report.rst @@ -28,11 +28,14 @@ summary``, and it looks like: .. code-block:: none - ☐ : Resource for NVDIMM detection - ☑ : Display USB devices attached to SUT - ☒ : Test USB 2.0 or 1.1 ports - ☑ : Collect information about supported types of USB - ☒ : Test USB 3.0 or 3.1 ports + ☑ : A job that always passes + ☒ : A job that always fails + ⚠ : A job that always crashes + ☑ : A job that depends on other job that passes + ☐ : A job that is skipped because it depends on a job that fails + ☑ : A job that generates different resources for tutorial purposes + ☑ : A job that requires a resource and it is available + ... Checkout this table to map outcome symbols to their corresponding descriptions: @@ -101,11 +104,18 @@ Now, let's explore each of the submission files together! - System Information - Tests Results - Logs + +.. figure:: ../../_images/checkbox-tutorial-test-report.png + + Tutorial HTML report + - You can expand entries in Tests Results and Logs sections to access more - detailed information. Additionally, you can utilize *search bar* to filter - specific tests for easier navigation. For instance, type "audio" in the - search bar to view all test results related to audio testing. +You can expand entries in Tests Results and Logs sections to access more +detailed information. + +Additionally, if the report is more complex, you can utilize the *search bar* to +filter specific tests for easier navigation. For instance, if you type "audio" +in the search bar, you can view all test results related to audio testing. .. figure:: ../../_images/checkbox-test-report.png