[docs] Add best practice on using relfection in tests.#1590
Open
kabalin wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new unit-testing best-practice section to Moodle DevDocs, aiming to discourage the use of reflection in tests and encourage designs that preserve encapsulation.
Changes:
- Introduces a new “Respect encapsulation” subsection under “Best practice”.
- Provides guidance on avoiding reflection/visibility changes and preferring public APIs (with suggested alternatives).
Comment on lines
+635
to
+638
| As a general principle, testing should not compromise encapsulation. Most behavior should be verifiable through public methods without need of using reflection. If substantial logic exists only behind private or protected methods, this may indicate that responsibilities should be extracted into a separate class with own public API. | ||
|
|
||
| - Avoid changing API visibility in core code solely to simplify testing. | ||
| - Prefer testing public APIs, as this use internal implementation details while preserving encapsulation. |
| As a general principle, testing should not compromise encapsulation. Most behavior should be verifiable through public methods without need of using reflection. If substantial logic exists only behind private or protected methods, this may indicate that responsibilities should be extracted into a separate class with own public API. | ||
|
|
||
| - Avoid changing API visibility in core code solely to simplify testing. | ||
| - Prefer testing public APIs, as this use internal implementation details while preserving encapsulation. |
Comment on lines
+633
to
+637
| ### Respect encapsulation | ||
|
|
||
| As a general principle, testing should not compromise encapsulation. Most behavior should be verifiable through public methods without need of using reflection. If substantial logic exists only behind private or protected methods, this may indicate that responsibilities should be extracted into a separate class with own public API. | ||
|
|
||
| - Avoid changing API visibility in core code solely to simplify testing. |
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
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.
Addressing https://moodle.atlassian.net/browse/MDLSITE-4144