Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(MTE)! set default NetworkMode to NONE #5041

Merged
merged 3 commits into from
Jun 7, 2022
Merged

Conversation

keturn
Copy link
Member

@keturn keturn commented Jun 5, 2022

This changes MTE's default network mode from LISTEN_SERVER to NONE.

I expect this to provide in increased reliability and speed for most MTE tests, as it removes the question of whether the server port is available and the delay on network shutdown.

Those few tests that do use createClient will need to adjust by setting their NetworkMode to LISTEN_SERVER or DEDICATED_SERVER.

The other potential incompatibility is that NONE does start with a Player; LISTEN_SERVER did not. That may be a problem if the environment does not provide a place for the player to spawn.

(Currently, we do not have any way of starting without either a network server or a player.)

Related:

How to test

Run integrationTest in modules. Note only modules that import MTE from engine.integrationtest will be affected; check for module pull requests linked to #5010.

@keturn keturn added Category: Test/QA Requests, Issues and Changes targeting tests and quality assurance Size: S Small effort likely only affecting a single area and requiring little to no research labels Jun 5, 2022
Copy link
Member

@skaldarnar skaldarnar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit afraid that the info when to set the network mode gets bit lost once this PR is merged.

Can we please add this info somewhere? Maybe in the docstring of createClient (if that's the only reason why you'll need a network-enabled mode)?

/**
* Creates a new client and connects it to the host
*
* @return the created client's context object
*/
Context createClient() throws IOException;

Or should we expand the Testing Modules section in the engine's wiki?

Other than that, this looks good to merge to me.

@keturn
Copy link
Member Author

keturn commented Jun 7, 2022

Added a note to the createClient docstring. Good suggestion, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Test/QA Requests, Issues and Changes targeting tests and quality assurance Size: S Small effort likely only affecting a single area and requiring little to no research
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants