The PHPCS native Config class uses a number of static properties, which may be updated during tests. These were previously reset to their default values in the UtilityMethodTestCase::resetTestFile() method, but this reset was inadvertently removed in commit https://github.com/PHPCSStandards/PHPCSUtils/pull/550/commits/4f0f9a4af04db6a3de28d657d06e707187c0c152 with the reasoning that, if all tests use the ConfigDouble, the reset would no longer be needed as the ConfigDouble resets on being initialized.
The flaw in this logic is that not all tests are guaranteed to use the ConfigDouble, which means that without the reset, the Config class may be left "dirty" after tests using the ConfigDouble, which could break tests.
This commit fixes this issue by:
Adding a __destruct() method to the ConfigDouble class which will reset the static properties on the PHPCS native Config class whenever an object created from this class is destroyed.
Explicitly calling the __destruct() method from the UtilityMethodTestCase::resetTestFile() method to ensure it is always run after a test has finished ("after class"), even if there would still be a lingering reference to the object.
Includes tests for the new __destruct() method.
Includes an additional test for the UtilityMethodTestCase class to ensure this snafu cannot come back without tests failing on it.
Props to @fredden for helping me debug this issue.
The PHPCS native
Configclass uses a number of static properties, which may be updated during tests. These were previously reset to their default values in theUtilityMethodTestCase::resetTestFile()method, but this reset was inadvertently removed in commit https://github.com/PHPCSStandards/PHPCSUtils/pull/550/commits/4f0f9a4af04db6a3de28d657d06e707187c0c152 with the reasoning that, if all tests use theConfigDouble, the reset would no longer be needed as theConfigDoubleresets on being initialized.The flaw in this logic is that not all tests are guaranteed to use the
ConfigDouble, which means that without the reset, theConfigclass may be left "dirty" after tests using theConfigDouble, which could break tests.This commit fixes this issue by:
__destruct()method to theConfigDoubleclass which will reset the static properties on the PHPCS nativeConfigclass whenever an object created from this class is destroyed.__destruct()method from theUtilityMethodTestCase::resetTestFile()method to ensure it is always run after a test has finished ("after class"), even if there would still be a lingering reference to the object.Includes tests for the new
__destruct()method. Includes an additional test for theUtilityMethodTestCaseclass to ensure this snafu cannot come back without tests failing on it.Props to @fredden for helping me debug this issue.