test: add info logs to help track down sporadic #5040
Merged
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
jdrueckert
added
Topic: Stabilization
skaldarnar
previously approved these changes
Jun 4, 2022
skaldarnar
previously approved these changes
Jun 4, 2022
skaldarnar
reviewed
Jun 4, 2022
Comment on lines
+139
to
+141
| if (!connectToHost(client, mainLoop)) { | ||
| throw new RuntimeException(String.format("Could not connect client %s to local host - timeout.", client)); | ||
| } |
There was a problem hiding this comment.
This part uses the information whether the connection was successful or not. The runtime exception will hopefully show up nicely in the test results to give us a hint that this precondition did not hold.
| terasologyEngine.getFromEngineContext(SystemConfig.class).writeSaveGamesEnabled.set(false); | ||
| terasologyEngine.subscribeToStateChange(new HeadlessStateChangeListener(terasologyEngine)); | ||
| terasologyEngine.changeState(new TestingStateHeadlessSetup(dependencies, worldGeneratorUri)); | ||
| TerasologyEngine host = createHeadlessEngine(); |
There was a problem hiding this comment.
Just a rename to make it less confusing which "engine" is a client and which is a host.
skaldarnar
approved these changes
Jun 4, 2022
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.
We saw a sporadic test failure on
developbuilds recently (e.g., develop/709 a0c6606).To help understand which of the "engines" is actually in the wrong state, we add some logging information about the instances.
This should help to figure out whether the
createClient()method is errorneous (as it should be blocking until the client is in state in-game) or the failure lies with the host's engine.Furthermore, this PR changes
Engines::connectToHostto return whether waiting for the engine to enterStateIngamesucceeded or timed out. This allows to fail early and intentionally if the engine did not make it into the expected state.