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.

Sign up for GitHub

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

Jump to bottom

Deprecate TestCase::getObjectForTrait() #5244

Closed
sebastianbergmann opened this issue Feb 23, 2023 · 0 comments
Closed

Deprecate TestCase::getObjectForTrait() #5244

sebastianbergmann opened this issue Feb 23, 2023 · 0 comments
Assignees
@sebastianbergmann
Labels
feature/test-doubles Test Stubs and Mock Objects type/deprecation Something will be/is deprecated
Milestone
PHPUnit 11.0

Comments

@sebastianbergmann
Copy link
Owner

sebastianbergmann commented Feb 23, 2023 •
edited
Loading

PHPUnit can automatically generate test stubs and mock objects (test doubles) based on interfaces and classes.

For quite a while, PHPUnit has offered the createStub() and createMock() methods for creating test stubs and mock objects with best practice defaults. Furthermore, alternatives such as getMockForTrait() exist, but not all of them offer the same clear separation between test double and mock object. For instance, no method named getStubForTrait() exists. Such an inconsistency can lead to confusion.

The getObjectForTrait() method returns a mock object for an otherwise empty class that uses a specified trait. This allows for testing the concrete methods of a trait.

Having to use getObjectForTrait() to test something is almost always a code smell: something is not quite right with the software design of the system-under-test.

To promote better software design, improve the readability of test code, and to reduce complexity inside PHPUnit's test double functionality, TestCase::getObjectForTrait() will be deprecated and then removed:

  • soft deprecation in PHPUnit 10.1 (add @deprecated annotation to the method declaration)
  • deprecation in PHPUnit 11 (using the method will trigger a deprecation)
  • removal in PHPUnit 12
@sebastianbergmann sebastianbergmann added type/backward-compatibility Something will be/is intentionally broken feature/test-doubles Test Stubs and Mock Objects labels Feb 23, 2023
@sebastianbergmann sebastianbergmann added this to the PHPUnit 11.0 milestone Feb 23, 2023
@sebastianbergmann sebastianbergmann mentioned this issue Feb 23, 2023
Closed
@sebastianbergmann sebastianbergmann self-assigned this Feb 23, 2023
@sebastianbergmann sebastianbergmann mentioned this issue Feb 24, 2023
Closed
sebastianbergmann added a commit that referenced this issue Feb 24, 2023
@sebastianbergmann
Soft-deprecate getObjectForTrait() for #5244
7d36bee
@sebastianbergmann sebastianbergmann mentioned this issue Feb 24, 2023
Closed
@sebastianbergmann sebastianbergmann changed the title Deprecate TestCase::getObjectForTrait() Deprecate TestCase::getObjectForTrait() Mar 6, 2023
@sebastianbergmann sebastianbergmann added type/deprecation Something will be/is deprecated and removed type/backward-compatibility Something will be/is intentionally broken labels Apr 11, 2023
sebastianbergmann added a commit that referenced this issue Aug 18, 2023
@sebastianbergmann
Also mark internal units of code as deprecated for #5241, #5242, #5243,
b82ee92 
#5244
moiikana added a commit to wmde/fun-validators that referenced this issue Jan 9, 2025
@moiikana
Add Stub for Trait to make phpstan happy
f02155d 
- it's not advised to test traits isolated from the code that actually uses the trait
sebastianbergmann/phpunit#5958
sebastianbergmann/phpunit#5244
- lots of code around mocking traits for that matter got deprecated in phpunit because of that

- that's why we try to use a stub class that uses the trait artificially to test its private method
moiikana added a commit to wmde/fun-validators that referenced this issue Jan 9, 2025
@moiikana
Add Stub for Trait to make phpstan happy
bc9487d 
- it's not advised to test traits isolated from the code that actually uses the trait
sebastianbergmann/phpunit#5958
sebastianbergmann/phpunit#5244
- lots of code around mocking traits for that matter got deprecated in phpunit because of that

- that's why we try to use a stub class that uses the trait artificially to test its private method
paulholden added a commit to paulholden/moodle that referenced this issue Feb 25, 2025
@paulholden
MDL-84639 reportbuilder: replace deprecated trait test mocking.
025cb9c 
"getObjectForTrait() is deprecated and will be removed in PHPUnit 12
without replacement."

See: sebastianbergmann/phpunit#5244
paulholden added a commit to paulholden/moodle that referenced this issue Feb 25, 2025
@paulholden
MDL-84639 reportbuilder: replace deprecated trait test mocking.
bc1cfb0 
"getObjectForTrait() is deprecated and will be removed in PHPUnit 12
without replacement."

See: sebastianbergmann/phpunit#5244
HuongNV13 pushed a commit to moodlehq/qbank that referenced this issue Feb 27, 2025
@paulholden @HuongNV13
MDL-84639 reportbuilder: replace deprecated trait test mocking.
52c56a8 
"getObjectForTrait() is deprecated and will be removed in PHPUnit 12
without replacement."

See: sebastianbergmann/phpunit#5244
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sebastianbergmann sebastianbergmann

Labels
feature/test-doubles Test Stubs and Mock Objects type/deprecation Something will be/is deprecated
Projects
None yet
Milestone
PHPUnit 11.0
Development

No branches or pull requests
1 participant
@sebastianbergmann