diff options
Diffstat (limited to 'docs/modules/ROOT/pages/meta-updater-testing.adoc')
| -rw-r--r-- | docs/modules/ROOT/pages/meta-updater-testing.adoc | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/modules/ROOT/pages/meta-updater-testing.adoc b/docs/modules/ROOT/pages/meta-updater-testing.adoc new file mode 100644 index 0000000..1e20c87 --- /dev/null +++ b/docs/modules/ROOT/pages/meta-updater-testing.adoc | |||
| @@ -0,0 +1,44 @@ | |||
| 1 | = Testing | ||
| 2 | |||
| 3 | //MC: No overlap with any content currently in the developer guide, but probably useful content to clean up and include. | ||
| 4 | |||
| 5 | == QA with oe-selftest | ||
| 6 | |||
| 7 | This layer relies on the test framework oe-selftest for quality assurance. Currently, you will need to run this in a build directory with `MACHINE` set to `qemux86-64`. Follow the steps below to run the tests: | ||
| 8 | |||
| 9 | 1. Append the line below to `conf/local.conf` to disable the warning about supported operating systems: | ||
| 10 | + | ||
| 11 | ``` | ||
| 12 | SANITY_TESTED_DISTROS = "" | ||
| 13 | ``` | ||
| 14 | |||
| 15 | 2. If your image does not already include an ssh daemon such as dropbear or openssh, add this line to `conf/local.conf` as well: | ||
| 16 | + | ||
| 17 | ``` | ||
| 18 | IMAGE_INSTALL_append = " dropbear " | ||
| 19 | ``` | ||
| 20 | |||
| 21 | 3. Some tests require that `SOTA_PACKED_CREDENTIALS` is set in your `conf/local.conf`. See the xref:dev@ota-build::sota-variables.adoc[SOTA-related variables in local.conf]. | ||
| 22 | |||
| 23 | 4. To be able to build an image for the GRUB tests, you will need to install the `ovmf` package as described in the xref:dev@ota-build::build.adoc#_dependencies[dependencies section]. | ||
| 24 | |||
| 25 | 5. Run oe-selftest: | ||
| 26 | + | ||
| 27 | ``` | ||
| 28 | oe-selftest -r updater_native updater_qemux86_64 updater_minnowboard updater_raspberrypi updater_qemux86_64_ptest | ||
| 29 | ``` | ||
| 30 | |||
| 31 | For more information about oe-selftest, including details about how to run individual test modules or classes, please refer to the https://wiki.yoctoproject.org/wiki/Oe-selftest[Yocto Project wiki]. | ||
| 32 | |||
| 33 | == Aktualizr test suite with ptest | ||
| 34 | |||
| 35 | The meta-updater layer includes support for running parts of the aktualizr test suite on deployed devices through link:https://wiki.yoctoproject.org/wiki/Ptest[Yocto's ptest functionality]. Since it adds significant build time cost, it is currently disabled by default. To enable it, add the following to your `conf/local.conf`: | ||
| 36 | |||
| 37 | ``` | ||
| 38 | PTEST_ENABLED_pn-aktualizr = "1" | ||
| 39 | IMAGE_INSTALL_append += " aktualizr-ptest ptest-runner " | ||
| 40 | ``` | ||
| 41 | |||
| 42 | Be aware that it will add several hundreds of MB to the generated file system. | ||
| 43 | |||
| 44 | The aktualizr tests will now be part of the deployed ptest suite, which can be run by calling `ptest-runner`. Alternatively, the required files and run script can be found in `/usr/lib/aktualizr/ptest`. | ||
