Introduced improved way to interact with settings in tests #12834
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.
Description
This PR improves the way settings are interacted with in tests. Previously, in most feature tests we would have to set up app settings by adding the following to the top of each test:
In addition, subsequent changes to settings had the possibility of not talking practical effect if
Setting::getSettings()
was called prior to the changes since that method caches settings in a static variable.This PR introduces a trait and fluent interface for interacting with settings in a similar manner as Laravel's
WithFaker
trait.Tests that need to interact with the application's settings should add the
InteractsWithSettings
trait to the class. Our baseTestCase
'ssetUp
method checks for this trait and will initialize the app's settings using the Setting factory. It will also allow tests to use the following syntax for updating application settings within tests:Additional helper methods like
enableMultipleFullCompanySupport()
can be added to theSettings
class as they are needed.Note: I'm avoiding updating the testing docs to document this because I want to use it in other pieces of work a bit to make sure the API is solid.