Add instructions to enable fail points for test suite #846
Conversation
This file contains hidden or 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
Several tests require use of the configureFailPoint command to trigger server-side errors. The command must be enabled via configuration file or command line option when starting mongod. The configureFailPoint command is not yet documented; see DOCS-10784.
kevinAlbs approved these changes Aug 13, 2021
Collaborator
kevinAlbs left a comment
kevinAlbs left a comment There was a problem hiding this comment.
Thank you for the thorough description. This should save new developers some time in researching how to run tests. LGTM.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Several tests require use of the
configureFailPointcommand to trigger server-side errors. The command must be enabled via configuration file or command line option when startingmongod.The
configureFailPointcommand is not yet documented; see DOCS-10784.This PR is motivated by my experience following written instructions to run the test suite locally. After following instructions, several tests were failing due to the error:
no such command: 'configureFailPoint'.Diagnosing this issue was difficult due to the
configureFailPointcommand having little to no documentation. It is however mentioned in the unified test format specification. To correctly run the entire test suite, fail points must be enabled via theenableTestCommandsserver parameter. Discovering this was difficult due to relevant information being scattered around in unusual locations; notably, it is not mentioned in any official documentation pages.This PR seeks to improve the accuracy of testing instructions by explicitly including the command line option when starting
mongod.