Make it possible to extend SetupScript

[iPurpl3x]

Changes proposed in this pull request:

Make it possible to extend Flarum\Testing\integration\Setup\SetupScript and added a public method to add settings to the initial installation pipeline.

New usage example:

(new SetupScript())
    ->addSettings([...])
    ->run();

As documented, the new method can be used to add settings to the Flarum installation.
Should be used only when it is really needed.
This can be useful in rare cases where the settings are required to be set already when extensions Extenders are executed. In those cases, setting the settings with the setting() method of the TestCase will not work.

Reviewers should focus on:
The new methods work and don't break any existing code.

Necessity

• Has the problem that is being solved here been clearly explained?
• If applicable, have various options for solving this problem been considered?
• For core PRs, does this need to be in core, or could it be in an extension?
• Are we willing to maintain this for years / potentially forever?

Confirmed

• Backend changes: tests are green (run composer test).
• Core developer confirmed locally this works as intended.
• Tests have been added, or are not appropriate here.

[SychO9]

What's the use case for this? I'd rather make sure the current codebase doesn't allow you to achieve your use case before making the change.

[iPurpl3x]

Hi @SychO9

In my use-case, I needed to activate some extensions (like flarum/tags) because else, no matter if I did $this->extension('flarum-tags'); in the TestCase or not, the test would fail because a migration of the extension I am writing the test in, required flarum/tags to be enabled, as it alters the tag_user table. Seems like migrations are executed before $this->extension(...);

Also, I realized that making settings with $this->setting(...) was not helping to use glowingblue/redis-setup. But when I set ['glowingblue-redis.enableCache' => true] in the setup, it works as expected.

This is now my setup.php code:

$setup = (new SetupScript())
	->addSettings([
		'glowingblue-redis.enableCache' => true,
	])
	->addExtensions([
		'flarum-tags',
		'flarum-likes',
		'glowingblue-redis-setup',
	])
	->run();

[SychO9]

The extension and setting methods will have no effect if you are calling them after the application has already been booted, which is very likely what's happening in your tests, because otherwise, migrations run just fine for specified extensions, and some for settings.

Lookout for anything in your tests that could be causing your tests to boot the application earlier than you want, like resolving a class, or making manual database changes or an early request ..etc

[iPurpl3x]

Yes I get that, so I need to change the code here : https://github.com/glowingblue/flarum-ext-redis-setup/blob/master/src/Extend/EnableRedis.php#L40 ?

And what about the migrations that fail ?

[SychO9]

I don't know how that ties into the test code so I can't tell, maybe if you share the test code in the discord server

[iPurpl3x]

I made the update as discussed over Discord @SychO9. If you want to make any adjustments to the docblock I wrote, let me know.