common_test: Document fail return from init callbacks#11355
Draft
ausimian wants to merge 1 commit into
Draft
Conversation
Document that init_per_suite/1 and init_per_group/2 may return {fail, Reason}. This behavior is already handled by Common Test, but the ct_suite callback types and example suite templates only mentioned skip returns.
Update the callback specs and descriptions, and align the Common Test example chapter with the documented return values.
Closes erlang#8952
Contributor
CT Test Results 2 files 58 suites 1h 15m 33s ⏱️ Results for commit 1406fd6. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
init_per_suite/1andinit_per_group/2may return{fail, Reason}.{fail, Reason}to thect_suitecallback specs.Why
Common Test already handles
{fail, Reason}from these init callbacks, but the public callback docs and examples only mentioned skip returns. This aligns the documentation with the existing behavior.Closes #8952.
Testing
./otp_build configuremake common_testusing OTP 29 inPATHgit diff --check