Complex Config Test

Hey @julien_bonnier!

Yes, this is possible but... not super straight forward. The best method I've found is to use separate test-environments for different configuration permutations.

I do this in zenstruck/messenger-test:

1. Create a yaml file for the different configuration named by the environment
2. In the TestKernel, load these different yaml files based on the environment name
3. In your tests, pass the environment you wish to load in self::bootKernel()

Hope that helps!
Kevin

@kbond It feels a bit hackish, but it works so I ended up doing it.

Also, worth mentioning that you could remove the different config files and use

when@test_environment_name:

Ah, that is a great idea! So you only need to manage a single config file. I like this much better.

In messenger-test, I combine multiple configs using import - just to reduce duplication but... I think it's
worth the duplication to better understand the full environment.

Awwww....

Thank you @kbond for the answer.

I think that way is not great, but if this is the only way to do it... I guess, I'll have to.

Thanks again

Looks like the answer for my question is here https://symfony.com/doc/cur... . In fact I implemented PrependeExtensionInterface for 'framework' extension and it works OK now!

Hey erop!

To give you a bigger answer about this, I'll mention 2 things :).

1) When you're inside your bundle's "extension" class (which is what you use to your bundles services.xml file), you're passed a ContainerBuilder object. But that is NOT the "main" ContainerBuilder. Symfony passes each bundle an empty ContainerBuilder. Then, you add your services to it and - eventually - Symfony merges all of them together. It does that so that each bundle can't "interfere" with the services for other bundles. THAT is why you got the "There is no extension able...." thing - only the "main" ContainerBuilder is aware of the ability to process the "framework" config. That's also on purpose - the bundle-config (like framework, or twig, or doctrine) is really meant to be used by end-users and not by applications.

2) So, most of the time, when you want to configure another bundle in some way, there is some non-configuration hook point to do it. Maybe you need to create an event listener, or create a service with some special tag to "hook into" the system. What you're doing is, sort of, the "last resort". I'm not saying it's wrong (I've definitely seen bundles do it) - but it's the last place to look for a hook point. In you case, if it works well, I actually don't see any big issue with it :).

Cheers!

Hey erop

Interesting use-case, I'm glad that you could find the solution by yourself. Thanks for sharing it with others!

Cheers!

Hey @Raph!

Are you testing your application or testing a bundle that you will share, like we do in this tutorial? In this tutorial, indeed, you might find that you boot several different kernels with configuration. But these kernels are so small, they shouldn't take long at all to boot (and for the cache to be built). If you're testing your application (where, indeed, the container/kernel can become quite large), then that's different. However, in that case, you typically are booting your kernel just so you can fetch out services. And so, you typically are only booting your *one* kernel - and not rebuilding its cache.

I think your situation is maybe more the second... but with some special situation? You said:

> In my case only the configuration of one bundle changes over tests

Can you tell me more about that? Are you testing your application... but sometimes you boot your one kernel... with different configuration being passed to a specific bundle? I don't understand... so I bet I'm missing something ;).

Cheers!

It's a bundle and it can be configured. (An app' requiring it would do that from config/package/my-bundle.yaml).

I'd like to test multiple bundle's configurations especially since its configuration affects the services it provides. For example if `driver1 is set in the configuration, then it will create a mybunde.Driver1 service. It's not an uncommon pattern. For example the <i>qpush-bundle</i> creates one Queue` service per configuration-defined queue : https://github.com/uecode/qpush-bundle/blob/master/src/DependencyInjection/UecodeQPushExtension.php#L63 (although I'm not sure it deserves being named the "Service Factoring" as in https://symfonycasts.com/screencast/phpspec/factory-class)

In such a case, each test needs to bootstrap the kernel then clear its cache and in my case this takes 4 minutes for less 20 tests (30min for my testsuite on GitLab.com), almost exclusively dedicated to booting the kernel and cache-clearing afterwards. It'd run under 15 seconds with a static kernel (but most tests would then fail).

Hey Raph!

Yep, it makes perfect sense then - I would probably do something very similar. A few questions/points, however:

1) You shouldn't need to specifically clear the cache after. I mean, as long as you make sure that each kernel has its own "cache" directory (I often do this by setting some random "key" in the kernel's constructor, setting it on a property, and using it in getCacheDir), then nautrally each kernel will start pre-cleared because its cache will be empty. I'm not sure how much this will speed things up... but try it :).

2) Typically in a test like this (at least when you're creating a *truly* re-usable bundle - i.e. one that could be used in any Symfony app), the "kernel" that you're creating is very small - you usually are booting just a few bundles that your bundle depends on - for example - https://github.com/symfony/... - which just needs 3 bundles. In these cases, the kernel boots very fast - certainly in a few seconds... but probably under a second. Are you needing to boot many bundles / your entire app to run the tests?

Cheers!

Thinking further about this issue, my testsuite which boots the kernel many dozens of times, goes from ~40 seconds to >15 minutes... when enabling code coverage. Said another way: it's all about xdebug slowing-down kernel boot.
I fear this thread goes off-topic and I don't want to add to much unrelated noise.
(But I hope xdebug can be selectively disabled during phpunit kernel-boot process)

Closing that specific thread on a positive note: I switched to pcov (implying an update to phpunit 8) and disabled xdebug.

The testsuite with coverage runs in less than a minute (as fast as if no coverage was requested at all) instead of 15 minutes.

Hey Felipe L.

Did you register the StubWordList service on your testing kernel?
Where those the "X Y" comes from?

Sorry MolloKhan , ignore all this.
I forgot to remove the service from config.yaml, (lesson 2!)
I've removed and all works, rewrite services.xml as lesson 8 and all good.

thanks for you time anyway.

Ha! Nice, I'm glad to hear that you could fix your problem
And don't worry about this - everybody makes mistakes ;)

Hi MolloKhan ,

I've done some debugging and I'm not sure that my <i>CustomWordProvider</i> is working at all.
I had to change add some lines on <i>service.xml</i> in order to make the bundle works.

Latest version of that file, I got from Lesson 8 looks like this:

`
<service id="knpu_lorem_ipsum.knpu_ipsum" class="KnpU\LoremIpsumBundle\KnpUIpsum" public="true">

 <argument type="service" id="knpu_lorem_ipsum.word_provider" />

</service>
<service id="knpu_lorem_ipsum.knpu_word_provider" class="KnpU\LoremIpsumBundle\KnpUWordProvider" />
<service id="knpu_lorem_ipsum.word_provider" alias="knpu_lorem_ipsum.knpu_word_provider" public="false" />
<service id="KnpU\LoremIpsumBundle\KnpUIpsum" alias="knpu_lorem_ipsum.knpu_ipsum" public="false" />
`

Got the following error:
<a href="https://imgur.com/a/v22OLJQ&quot;&gt;Cannot autowire service</a>

Then, I've made some changes and my service.xml looks like this:

`
<service id="knpu_lorem_ipsum.knpu_ipsum" class="KnpU\LoremIpsumBundle\KnpUIpsum" public="true">

<argument type="service" id="knpu_lorem_ipsum.knpu_word_provider" />

</service>
<service id="knpu_lorem_ipsum.knpu_word_provider" class="KnpU\LoremIpsumBundle\KnpUWordProvider" />
<service id="knpu_lorem_ipsum.word_provider" alias="knpu_lorem_ipsum.knpu_word_provider" public="false" />
<service id="KnpU\LoremIpsumBundle\KnpUWordProvider" alias="knpu_lorem_ipsum.knpu_word_provider" />
<service id="KnpU\LoremIpsumBundle\KnpUIpsum" alias="knpu_lorem_ipsum.knpu_ipsum" public="false" />
<service id="KnpU\LoremIpsumBundle\KnpUWordProvider" />
<service id="KnpU\LoremIpsumBundle\WordProviderInterface" alias="KnpU\LoremIpsumBundle\KnpUWordProvider" />
`

After these changes, it works but I'm not quite sure that CustomWordProvider is being loaded properly.
If I added 'beach', following the lesson, the word does not appear on the page.

thanks
Felipe

Hi MolloKhan ,

when you say register, you mean on <i>registerContainerConfiguration</i>, right?

If it does, the method looks like this:
`
$loader->load(function(ContainerBuilder $container) {

        $container->register('stub_word_list', StubWordList::class);

        $container->loadFromExtension('knpu_lorem_ipsum', $this->knpUIpsumConfig);
    });

`

thanks
Felipe