UI testing #67
Merged
UI testing #67
Conversation
This file contains 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
miek
reviewed
Apr 10, 2023
|
Oh, nice catch. I think that crept in due to some reordering; later in the #54 sequence itertools becomes a regular dependency so |
This avoids problems when inactive tests are left around by other branches, and makes it possible to add subdirectories in 'tests' without confusing the existing test code.
This is needed for tests using GTK to work on Linux.
This occurs when combining record-ui-test with step-decoder.
All the statements declaring submodules are now in lib.rs, which
defines a packetry crate, used by main.rs. The UI code is moved to
ui.rs, which is exposed to main.rs as part of the packetry crate.
The UI replay test is now a separate standalone program, test_replay.rs.
This is declared as a custom test in Cargo.toml, one not using the
standard cargo harness. It must be enabled specifically when testing:
cargo test --features=test-ui-replay
This solves the problem of not being able to run that test on macOS,
which requires GTK to be initialized and used only from the main thread.
The CI workflow is amended to test with the test-ui-replay feature
enabled, and to build the release binary without features enabled. All
current features are for debug and test purposes only.
|
Fixed! |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds new test infrastructure for recording and replaying UI interactions, along with a couple of test cases.
UI interactions are recorded through normal usage of the UI, by running with the
record-ui-testfeature, which writes out anactions.jsonfile describing all actions the user took, and anoutput.txtfile containing all information displayed by the UI as a result.A test case is created by adding a test name to
tests/ui/tests.txtand creating a directorytests/ui/<name>, containing theactions.jsonand the expected output named asreference.txt. When the tests are run, the actions are replayed into the UI, and a newoutput.txtfile is generated and compared toreference.txt.To the extent I found practical, the replay test exercises all the same UI code as normal operation, including full use of the GTK toolkit, but without actually displaying a window. This raised a couple of side issues:
DISPLAYsetting present to use GTK, so CI is modified to run the tests with an Xvfb server available.test_replay, which does not use the standard harness.test_replayis a separate program, this required moving most of Packetry into a library crate.cfg(test)set, so blocks in the UI code that are required bytest_replayhave to be feature gated instead.cargo test --features=test-ui-replay.Some changes are also made to the existing decoder tests:
tests/tests.txt, rather than listing thetestsdirectory.This PR is part of the planned sequence documented in #54. The next PR will add interleaving support to the tree view. The tests in this PR will be used to verify that the UI behaves correctly after the changes.