docs: Add TESTING.md #125
Open
docs: Add TESTING.md #125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Provide a step by step guide to how to test the generated particleos image. That can help developer for testing their contributions.
DaanDeMeyer
requested changes
Dec 31, 2025
Collaborator
DaanDeMeyer
left a comment
DaanDeMeyer
left a comment
There was a problem hiding this comment.
This seems to be duplicating too much from the readme. Frankly I'd much prefer adding a few of the missing sections to the readme rather than introducing a new document and repeating everything there
Comment on lines
+10
to
+27
| Welcome to the **particleOS Testing and Validation Guide**. This document | ||
| outlines the comprehensive procedure for developers and contributors, covering | ||
| the entire workflow from building the particle OS image to performing an | ||
| installation on a simulated empty drive and finally testing the resulting | ||
| installed system within a Virtual Machine environment. | ||
|
|
||
| The goal is to provide clear, actionable instructions to facilitate a smooth | ||
| setup of your development environment, enabling effective building, | ||
| installation, and testing of changes to the particleOS project. | ||
|
|
||
| Welcome to the particleos testing guide! This document provides the step by step | ||
| guide from the particleOS image creation to the test in Virtual Machine | ||
| of the final installed image, going through the installation process on an | ||
| empty drive. | ||
|
|
||
| It aims to be a comprehensive guide for developers who want to contribute to the | ||
| project by providing clear instructions on how to set up a development | ||
| environment, build the project, and test their changes. |
Collaborator
There was a problem hiding this comment.
You're saying the same thing twice in this section did you proofread this?
|
|
||
| ### Environment setup | ||
|
|
||
| * Before you start testing on particleos, make sure to have the **lastest** |
Comment on lines
+34
to
+56
| version of `mkosi` accessible from your path-environment. | ||
|
|
||
| ```bash | ||
| cd ${WORKDIR} | ||
| git clone https://github.com/systemd/mkosi.git | ||
| export PATH="${WORKDIR}/mkosi/bin/:${PATH}" | ||
| ``` | ||
|
|
||
| * `mkosi` requires Python 3.8 or higher. You can install the lastest python | ||
| version and force the Interpreter as follow: | ||
|
|
||
| ```bash | ||
| export MKOSI_INTERPRETER="/usr/bin/python3.12" | ||
| ``` | ||
|
|
||
| * Verify the version of mkosi installed: | ||
|
|
||
| ```bash | ||
| mkosi --version | ||
| ``` | ||
|
|
||
| * You will also need `qemu` installed on your system to test the created images in | ||
| a virtual machine. |
Collaborator
There was a problem hiding this comment.
This is just rewording mkosi's readme. Please link to the mkosi documentation instead of repeating this all here.
| * You will also need `qemu` installed on your system to test the created images in | ||
| a virtual machine. | ||
|
|
||
| ### Lastest systemd version (optional but recommended) |
Comment on lines
+74
to
+87
| ```conf | ||
| [Match] | ||
| Distribution=opensuse | ||
|
|
||
| [Distribution] | ||
| Release=tumbleweed | ||
|
|
||
| [Runtime] | ||
| VirtualMachineMonitor=qemu | ||
|
|
||
| QemuArgs= | ||
| -drive if=none,file=./mkosi.output/target-disk.img,format=raw,id=installdisk | ||
| -device virtio-blk-pci,drive=installdisk | ||
| ``` |
Collaborator
There was a problem hiding this comment.
This flat out doesn't work on any distribution other than opensuse because of the [Match]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provide a step by step guide to how to test the generated particleos image. That can help developer for testing their contributions.