(REF) Extract LocaleTestTrait. Tighten up multilingual testing. #24291
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.
Overview
This is a test-only change. Generally, it tightens up the way in which multilingual mode is enabled/disabled -- with an aim to (a) improving realism, (b) reducing duplication, (c) recovering better from test-errors.
Technical Details
There are multiple steps to setting up a valid multilingual environment, such as:
Additionally, it is important to reverse these steps at the end. If there are scenarios where it doesn't cleanup (eg due to a failed test-assertion) or where it only partially cleans up
Before
Tests use some mix of:
$this->enableMultilingual()
or\CRM_Core_I18n_Schema::makeMultilingual()
\CRM_Core_I18n_Schema::makeSinglelingua()l
Some tests also don't do cleanup in a safe way (eg a failed assertion will cascade to break other tests)
If you try to run the entire
phpunit --group locale
, it doesn't work.After
More consistent code-style. Either:
$this->enableMultilingual(['srcLocale' => 'newLocale'])
and$this->disableMultilingual()
(with try/finally or setup/teardown)$cleanup = $this->useMultilingual(['srcLocale' => 'newLocale'])
If you try to run the entire
phpunit --group locale
, it does work.