Deprecate `TestCase::getMockForAbstractClass()` #5241

sebastianbergmann · 2023-02-23T14:15:34Z

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

When it comes to doubling classes, there are limitations:

final, private, and static methods cannot be doubled; they retain their original behavior except for static methods which will be replaced by a method throwing an exception
Enumerations (enum) are final classes and therefore cannot be doubled
readonly classes cannot be extended by classes that are not readonly and therefore cannot be doubled

Not only because of the limitations mentioned above, but also to improve your software design, PHPUnit's documentation recommends to favour the doubling of interfaces over the doubling of 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 getMockForAbstractClass() exist, but not all of them offer the same clear separation between test double and mock object. For instance, no method named getStubForAbstractClass() exists. Such an inconsistency can lead to confusion.

As its name suggests, the getMockForAbstractClass() method can be used to create a mock object for an abstract class: a mock object where all abstract methods of the original class are implemented in such a way that they can be configured to return a specified value, for instance, or to expect an invocation.

Having to use getMockForAbstractClass() 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::getMockForAbstractClass() 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

The text was updated successfully, but these errors were encountered:

See: sebastianbergmann/phpunit#5241

See: sebastianbergmann/phpunit#5241 It covers a platform-specific use case in the base platform class, which is pointless.

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow current best practices. This changes tackles the classes where we can mock an interface instead of an abstract class, allowing us to use `createMock` instead of `getMockForAbstractClass`. Resolves: #101609 Related: #101601 Releases: main, 12.4 Change-Id: I995f70d779a1bc6251bc4479c3dcb2ee548314f1 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80455 Tested-by: core-ci <typo3@b13.com> Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Stefan B�rk <stefan@buerk.tech> Tested-by: Stefan B�rk <stefan@buerk.tech>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow current best practices. This changes tackles the classes where we can mock an interface instead of an abstract class, allowing us to use `createMock` instead of `getMockForAbstractClass`. Resolves: #101609 Related: #101601 Releases: main, 12.4 Change-Id: I995f70d779a1bc6251bc4479c3dcb2ee548314f1 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80458 Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: core-ci <typo3@b13.com> Tested-by: Christian Kuhn <lolli@schwarzbu.ch>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow current best practices. This changes tackles the classes where we can mock an interface instead of an abstract class, allowing us to use `createMock` instead of `getMockForAbstractClass`. Resolves: #101609 Related: #101601 Releases: main, 12.4 Change-Id: I995f70d779a1bc6251bc4479c3dcb2ee548314f1 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80455 Tested-by: core-ci <typo3@b13.com> Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Stefan B�rk <stefan@buerk.tech> Tested-by: Stefan B�rk <stefan@buerk.tech>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101630 Related: #101601 Releases: main Change-Id: I27f526cb7ee4e1f2081c05befd3d70549dd0e2fd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80470 Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de> Tested-by: Andreas Nedbal <andy@pixelde.su> Reviewed-by: Lina Wolf <112@linawolf.de> Tested-by: core-ci <typo3@b13.com> Tested-by: Lina Wolf <112@linawolf.de> Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de> Reviewed-by: Andreas Nedbal <andy@pixelde.su>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101666 Related: #101601 Releases: main Change-Id: I0263ff7b0639d72ba1d4f30e3bee12276d364591 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80526 Reviewed-by: Stefan B�rk <stefan@buerk.tech> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Nikita Hovratov <nikita.h@live.de> Tested-by: Nikita Hovratov <nikita.h@live.de> Tested-by: Stefan B�rk <stefan@buerk.tech>

#5244

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101661 Related: #101601 Releases: main Change-Id: I3b9ba4511620aebf125ff207428adc5483d47154 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80522 Tested-by: core-ci <typo3@b13.com> Reviewed-by: Stefan B�rk <stefan@buerk.tech> Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: Stefan B�rk <stefan@buerk.tech>

This method uses `getMockForAbstractClass()` under the hood, which in turn has been soft-deprecated in PHPUnit 10.1 and will issue deprecation warnings in PHPUnit 11 and up: sebastianbergmann/phpunit#5241 Releases: main

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101892 Related: #101601 Releases: main, 12.4 Change-Id: Id1977130c5e2a9bdc54fb92aea7dfc63ecf55724 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80940 Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: Benni Mack <benni@typo3.org> Reviewed-by: Benni Mack <benni@typo3.org> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101892 Related: #101601 Releases: main, 12.4 Change-Id: Id1977130c5e2a9bdc54fb92aea7dfc63ecf55724 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80952 Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101892 Related: #101601 Releases: main, 12.4 Change-Id: Id1977130c5e2a9bdc54fb92aea7dfc63ecf55724 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80940 Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: Benni Mack <benni@typo3.org> Reviewed-by: Benni Mack <benni@typo3.org> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101892 Related: #101601 Releases: main, 12.4 Change-Id: Id1977130c5e2a9bdc54fb92aea7dfc63ecf55724 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80952 Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101661 Related: #101601 Releases: main, 12.4 Change-Id: I3b9ba4511620aebf125ff207428adc5483d47154 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80944 Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101630 Related: #101601 Releases: main, 12.4 Change-Id: I27f526cb7ee4e1f2081c05befd3d70549dd0e2fd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80945 Tested-by: core-ci <typo3@b13.com> Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101666 Related: #101601 Releases: main, 12.4 Change-Id: I0263ff7b0639d72ba1d4f30e3bee12276d364591 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80946 Tested-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Benjamin Franzke <ben@bnf.dev>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101630 Related: #101601 Releases: main, 12.4 Change-Id: I27f526cb7ee4e1f2081c05befd3d70549dd0e2fd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80945 Tested-by: core-ci <typo3@b13.com> Tested-by: Benjamin Franzke <ben@bnf.dev> Reviewed-by: Benjamin Franzke <ben@bnf.dev>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101661 Related: #101601 Releases: main, 12.4 Change-Id: I3b9ba4511620aebf125ff207428adc5483d47154 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80944 Reviewed-by: Benjamin Franzke <ben@bnf.dev> Tested-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101666 Related: #101601 Releases: main, 12.4 Change-Id: I0263ff7b0639d72ba1d4f30e3bee12276d364591 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80946 Tested-by: Benjamin Franzke <ben@bnf.dev> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Benjamin Franzke <ben@bnf.dev>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. This change also cleans up the affected test to better match the setup/execute/verify structure. Resolves: #102117 Related: #101601 Releases: main, 12.4 Change-Id: Iaa6cee9893d41cb95e20cda80e03f044d52d82cd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/81350 Reviewed-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Stefan Bürk <stefan@buerk.tech> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. This change also cleans up the affected test to better match the setup/execute/verify structure. Resolves: #102117 Related: #101601 Releases: main, 12.4 Change-Id: Iaa6cee9893d41cb95e20cda80e03f044d52d82cd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/81374 Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Stefan Bürk <stefan@buerk.tech>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. This change also cleans up the affected test to better match the setup/execute/verify structure. Resolves: #102117 Related: #101601 Releases: main, 12.4 Change-Id: Iaa6cee9893d41cb95e20cda80e03f044d52d82cd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/81350 Reviewed-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Stefan Bürk <stefan@buerk.tech> Tested-by: core-ci <typo3@b13.com>

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. This change also cleans up the affected test to better match the setup/execute/verify structure. Resolves: #102117 Related: #101601 Releases: main, 12.4 Change-Id: Iaa6cee9893d41cb95e20cda80e03f044d52d82cd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/81374 Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Stefan Bürk <stefan@buerk.tech>

* Remove calls to getMockForAbstractClass(), see [1] * Remove calls to PHPUnit method returnValueMap, see [2] * Work around issue with deprecated test_suffix CSV, see [3] * Do not explicitly add `-colors=always` since it is already added [4] [1]: sebastianbergmann/phpunit#5241 [2]: sebastianbergmann/phpunit#5423 [3]: php-actions/phpunit#64 [4]: https://github.com/php-actions/phpunit/blob/c27e49b5fd8cd59d032b7b4441d2e15f23cf6519/phpunit-action.bash#L154

…aubois) This PR was merged into the 5.4 branch. Discussion ---------- Remove calls to `getMockForAbstractClass()` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT This method is deprecated (see sebastianbergmann/phpunit#5241), and must be replaced where used. Commits ------- a1843f3 Remove calls to `getMockForAbstractClass()`

sebastianbergmann added type/backward-compatibility Something will be/is intentionally broken feature/test-doubles Stubs and Mock Objects labels Feb 23, 2023

sebastianbergmann added this to the PHPUnit 11.0 milestone Feb 23, 2023

sebastianbergmann mentioned this issue Feb 23, 2023

Remove TestCase::getMockForAbstractClass() #5247

Open

sebastianbergmann self-assigned this Feb 23, 2023

sebastianbergmann mentioned this issue Feb 24, 2023

Deprecate TestCase::getMockBuilder() #5252

Closed

sebastianbergmann added a commit that referenced this issue Feb 24, 2023

Soft-deprecate getMockForAbstractClass() for #5241

26a33f7

sebastianbergmann added a commit to sebastianbergmann/phpunit-documentation-english that referenced this issue Feb 24, 2023

Add note about sebastianbergmann/phpunit#5241

192fab6

sebastianbergmann changed the title ~~Deprecate TestCase::getMockForAbstractClass()~~ Deprecate TestCase::getMockForAbstractClass() Mar 6, 2023

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 mentioned this issue Apr 11, 2023

Deprecate MockBuilder::getMockForAbstractClass() #5305

Closed

morozov added a commit to morozov/dbal that referenced this issue Jun 14, 2023

GetMockForAbstractClass

f933619

See: sebastianbergmann/phpunit#5241

morozov added a commit to morozov/dbal that referenced this issue Jun 14, 2023

GetMockForAbstractClass

0016eda

See: sebastianbergmann/phpunit#5241

morozov added a commit to morozov/dbal that referenced this issue Jun 14, 2023

Rework the tests using TestCase::getMockForAbstractClass()

c619456

See: sebastianbergmann/phpunit#5241

morozov added a commit to morozov/dbal that referenced this issue Jun 14, 2023

Rework the tests using TestCase::getMockForAbstractClass()

1dc87d0

See: sebastianbergmann/phpunit#5241

morozov added a commit to morozov/dbal that referenced this issue Jun 16, 2023

Remove the test that uses TestCase::getMockForAbstractClass()

4ab634b

See: sebastianbergmann/phpunit#5241 It covers a platform-specific use case in the base platform class, which is pointless.

sebastianbergmann added a commit that referenced this issue Aug 18, 2023

Also mark internal units of code as deprecated for #5241, #5242, #5243,

b82ee92

#5244

oliverklee mentioned this issue Aug 28, 2023

[TASK] Deprecate getAccessibleMockForAbstractClass TYPO3/testing-framework#495

Merged

W0rma mentioned this issue Oct 6, 2023

Fix compatibility with PHPUnit 10.4 Codeception/Stub#47

Merged

sebastianbergmann closed this as completed in 91dcea7 Oct 13, 2023

williamjallen mentioned this issue Dec 6, 2023

PHPUnit getMockForAbstractClass() is deprecated Kitware/CDash#1870

Open

cookieguru mentioned this issue Apr 12, 2024

Upgrade PHP Code Sniffer, resolve PHPUnit deprecations MergePHP/mergephp-website#43

Merged

alexandre-daubois mentioned this issue Apr 26, 2024

Remove calls to getMockForAbstractClass() symfony/symfony#54745

Merged

tannguyen04 mentioned this issue Jul 4, 2024

Enabled Drupal 11 CI test jobs AlexSkrypnyk/generated_content#39

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `TestCase::getMockForAbstractClass()` #5241

Deprecate `TestCase::getMockForAbstractClass()` #5241

sebastianbergmann commented Feb 23, 2023 •

edited

Loading

Deprecate TestCase::getMockForAbstractClass() #5241

Deprecate TestCase::getMockForAbstractClass() #5241

Comments

sebastianbergmann commented Feb 23, 2023 • edited Loading

Deprecate `TestCase::getMockForAbstractClass()` #5241

Deprecate `TestCase::getMockForAbstractClass()` #5241

sebastianbergmann commented Feb 23, 2023 •

edited

Loading