docs: re-do the mir test plan #3392
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3392 +/- ##
==========================================
- Coverage 77.53% 77.51% -0.03%
==========================================
Files 1075 1065 -10
Lines 68300 67914 -386
==========================================
- Hits 52959 52642 -317
+ Misses 15341 15272 -69 ☔ View full report in Codecov by Sentry. |
mattkae
changed the title
There was a problem hiding this comment.
This is not "(mostly) a reorganization and categorization of the previous test plan".
The previous test plans details testing the Mir release candidate from ppa:mir-team/rc. There is a separate "test plan" that says we should also test mir-test-tools, ubuntu-frame, confined-shell and miriway. (But only details testing mir-test-tools). I don't think conflating these (and dropping testing of Frame and confined-shell) is helpful.
mattkae
changed the title
mattkae
force-pushed
the
docs/how_to_test_mir
branch
from
fc1636e
to
aac96b3
Compare
| 5. When you are running the compositor hosted in a session that supports wayland | ||
| _and_ you force Mir to use the `mir:wayland` platform using: | ||
| ``` | ||
| miral-app --platform-display-libs=mir:wayland --wayland-host=$WAYLAND_DISPLAY |
There was a problem hiding this comment.
I don't think that we need to force the wayland platform? --wayland-host=… should be enough?
Co-authored-by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
| 1. Run the `mir-test-smoke-runner` and confirm that the final output is: | ||
| `Smoke testing complete with returncode 0`. |
There was a problem hiding this comment.
We should state explicitly how to control the platform selected by the smoke tests.
E.g. testing on the virtual platform doesn't need to connect a VNC client (as described in the previous section), and it is easiest to use environment variables to select the platform:
MIR_SERVER_PLATFORM_DISPLAY_LIBS=mir:virtual MIR_SERVER_VIRTUAL_OUTPUT=1280x1024 mir-smoke-test-runnerThere was a problem hiding this comment.
For consistency, it might be better to use environment variables throughout.
There was a problem hiding this comment.
I kept a few as commandline params (e.g. --console-providers and --vt, but the others are now env variables)
mattkae
force-pushed
the
docs/how_to_test_mir
branch
from
a46be9d
to
2be6727
Compare
|
|
||
| ## Mir Console Providers | ||
|
|
||
| Run with different console providers and ensure that the compositor can start: |
There was a problem hiding this comment.
| Run with different console providers and ensure that the compositor can start: | |
| For each Ubuntu release ensure that the compositor can start with each of the console providers: |
| ```sh | ||
| miral-app --console-provider=vt --vt=4 | ||
| ``` | ||
| - This requires running with root privileges | ||
| - You need to ensure that `XDG_RUNTIME_DIR` is set in the environment. If using `sudo`, | ||
| it might strip this out; running something like `sudo env XDG_RUNTIME_DIR=/run/user/1000 miral-shell ...` | ||
| will ensure this is set. | ||
|
|
||
| ```sh | ||
| miral-app --console-provider=logind | ||
| ``` | ||
| - You can switch to vt4 and sign in | ||
|
|
||
| ```sh | ||
| miral-app --console-provider=minimal | ||
| ``` | ||
| - This is used when all others fail | ||
| - This does not provide VT switching capabilities (Ctrl-Alt-F1, etc) | ||
| - This is _only_ used for the `gbm-x11`, `gbm-wayland`, and `virtual` platforms |
There was a problem hiding this comment.
This could be better structured (similar to "Testing each graphics platform"), but OK for now.
There was a problem hiding this comment.
I made them match better
Co-authored-by: Alan Griffiths <alan@octopull.co.uk>
Click https://canonical-mir--3392.com.readthedocs.build/3392/how-to/how-to-test-mir-for-a-release/ to read the content
What's new?
To follow