Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
53 changes: 35 additions & 18 deletions docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Follow these steps to start Testrun:
Notes:

- Disable both adapters in the host system (IPv4, IPv6, and general) by opening **Settings**, then **Network**.
- Keep the DUT powered off until prompted.
- Keep the DUT powered off until prompted. Otherwise, Testrun will not be able to fully capture the device behavior during startup - resulting in inaccurate test results.

1. Start Testrun with the command `sudo testrun`
- To run Testrun in network-only mode (without running any tests), use the `--net-only` option.
Expand All @@ -87,25 +87,42 @@ Follow these steps to start Testrun:
Follow these steps to test your IoT device:

1. Open Testrun by navigating to [http://localhost:8080](http://localhost:8080/) in your browser.
2. Select the **Settings** menu in the top-right corner, then select your network interfaces. You can change the settings at any time.
![Settings menu button](/docs/ui/getstarted--7cfvdpdnc5o.png)
3. Select the **Certificates** menu in the top-right corner, then upload your local CA certificates for TLS server testing.
![Certificates menu button](/docs/ui/getstarted--j21skepmx1.png)
5. Select the **Device Repository** icon on the left panel to add a new device for testing.
![Device repository button](/docs/ui/getstarted--q5uw26tfod.png)
6. Select the **Add Device** button.
7. Enter the MAC address, manufacturer name, and model number.
2. Select the **Settings** menu in the top-right corner. It will open the **General** tab by default. Then select your network interfaces. You can change the settings at any time.
![Settings menu button](/docs/ui/getstarted-settings-menu.png)
3. Select the **Certificates** tab (Settings menu), then upload your local CA certificates for TLS server testing.
![Certificates menu button](/docs/ui/getstarted-certificates-menu.png)
4. Select the **Device Repository** icon on the left panel to add a new device for testing.
![Device repository button](/docs/ui/getstarted-device-repository.png)

Or

Click the **Actions** button to add a new device for testing.
![Actions button](/docs/ui/getstarted-actions-device.png)
5. Select the **Add Device** button on the Device repository.
![Add device](/docs/ui/getstarted-add-device.png)
6. Enter the MAC address, manufacturer name, and model number.
7. Select Qualification or Pilot program.
8. Select the test modules you want to enable for this device.
Note: For qualification purposes, you must select all.
9. Select **Save**.
10. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted--w09wecsry3.png)

11. Select the device you want to test.
12. Enter the version number of the firmware running on the device.
13. Select **Start Testrun**.
- If you need to stop Testrun during testing, select **Stop** next to the test name.
12. Once the Waiting for Device notification appears, power on the device under test. A report appears under the Reports icon once the test sequence is complete.
![Reports button](/docs/ui/getstarted--m4si1otdu5d.png)
9. Answer a few questions about your device.
10. Select **Save**.
11. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted-testing.png)

Or

Click the **Actions** button, then select the **Start Testing** button.
![Actions button](/docs/ui/getstarted-actions-testing.png)

12. Select the device you want to test.
13. Enter the version number of the firmware running on the device.
14. Select **Start Testrun**.
- If you need to stop Testrun during testing, select **Stop** next to the test name.
15. Once the Waiting for Device notification appears, power on the device under test.
![Waiting for device](/docs/ui/getstarted-waiting-for-device.png)
16. While testing is in progress, you could complete a Risk Assessment. To do so, go to the **Risk assessment** tab.
![Risk assessment](/docs/ui/getstarted-risk-assessment.png)
17. A report appears under the Reports icon once the test sequence is complete.
![Reports button](/docs/ui/getstarted-reports.png)

# Troubleshooting

Expand Down
Binary file added docs/roadmap.pdf
Binary file not shown.
Binary file removed docs/rooadmap.pdf
Binary file not shown.
Binary file removed docs/ui/getstarted--7cfvdpdnc5o.png
Binary file not shown.
Binary file removed docs/ui/getstarted--j21skepmx1.png
Binary file not shown.
Binary file removed docs/ui/getstarted--m4si1otdu5d.png
Binary file not shown.
Binary file removed docs/ui/getstarted--q5uw26tfod.png
Binary file not shown.
Binary file removed docs/ui/getstarted--w09wecsry3.png
Binary file not shown.
Binary file added docs/ui/getstarted-actions-device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-actions-testing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-add-device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-certificates-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-device-repository.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-risk-assessment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-settings-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-testing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/getstarted-waiting-for-device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion make/DEBIAN/control
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: Testrun
Version: 2.1.1
Version: 2.2
Architecture: amd64
Maintainer: Google <boddey@google.com>
Homepage: https://github.com/google/testrun
Expand Down
Loading