test(MTE): allow a test to add its own EngineSubsystem #5044
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
6 tasks
keturn
added
Category: Test/QA
This was referenced Jun 11, 2022
skaldarnar
approved these changes
Jun 12, 2022
| /** | ||
| * Do not add an extra subsystem to the integration environment. | ||
| * <p> | ||
| * [Odd marker interface because annotation fields cannot default to null.] |
There was a problem hiding this comment.
❓ Can/should one use Optional? Can there be more than subsystem added (in principle, not necessarily in practice)? If so, this could also be a list.
In any case, having this marker interface in engine-tests is just fine, as it is definitely understandable and we should probably not spent too much time and effort on this (now).
There was a problem hiding this comment.
I don't think we can. The list of types allowed to annotations is quite limited.
Comment on lines
+18
to
+39
| /** | ||
| * The network mode the host engine starts with. | ||
| * <p> | ||
| * See {@link NetworkMode} for details on the options. | ||
| * <p> | ||
| * Some modes automatically include a {@link LocalPlayer}. | ||
| * <p> | ||
| * If you want to simulate multiple players with | ||
| * {@link org.terasology.engine.integrationenvironment.Engines#createClient Engines.createClient}, | ||
| * you will need a mode with a {@linkplain NetworkMode#isServer() server}. | ||
| */ | ||
| NetworkMode networkMode() default NetworkMode.NONE; | ||
|
|
||
| /** | ||
| * Add an additional subsystem to the engine. | ||
| * <p> | ||
| * A new instance will be included in the engine's subsystems when it is created. | ||
| * <p> | ||
| * Implementing {@link EngineSubsystem#initialise} gives you the opportunity to | ||
| * make changes to the configuration <em>before</em> it would otherwise be available. | ||
| */ | ||
| Class<? extends EngineSubsystem> subsystem() default NO_SUBSYSTEM.class; |
There was a problem hiding this comment.
👍 thanks for the doc strings!
| @@ -195,16 +194,31 @@ TerasologyEngine createHeadlessEngine() throws IOException { | |||
| TerasologyEngine createHeadedEngine() throws IOException { | |||
| EngineSubsystem audio = new LwjglAudio(); | |||
| TerasologyEngineBuilder terasologyEngineBuilder = new TerasologyEngineBuilder() | |||
| .add(new WithUnittestModule()) | |||
| .add(new IntegrationEnvironmentSubsystem()) | |||
| .add(audio) | |||
There was a problem hiding this comment.
❓ for the sake of consistency, can we just inline the creation of audio here as well, or do we need it explicitly somewhere else?
Suggested change
| .add(audio) | |
| .add(new LwjglAudio()) |
| @@ -195,16 +194,31 @@ TerasologyEngine createHeadlessEngine() throws IOException { | |||
| TerasologyEngine createHeadedEngine() throws IOException { | |||
| EngineSubsystem audio = new LwjglAudio(); | |||
There was a problem hiding this comment.
Suggested change
| EngineSubsystem audio = new LwjglAudio(); |
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.
@IntegrationEnvironment(subsystem=SomeEngineSubsystem.class), giving the author more control during engine initialization and much more power to shoot themselves in the foot.integrationenvironment.Enginesand in to anIntegrationEnvironmentSubsystem. This makes it easier to guess when that code will be run (compared to usual non-MTE code), and makes it easier to override if needed.Review Hints
IntegrationEnvironmentSubsystem.registerCurrentDirectoryIfModule is a direct move of a method formerly in
integrationenvironent.Engines.How to test
This is an MTE-only change, so there's no player-visible impact. You could use
CustomSubsystemTestas an example to start from if you want to experiment with it yourself.