Update Symfony2 framework module and connector, fix client generation…

[vyarmolenko]

…, update Doctrine EM retrieval. Improve memory usage. Unify service retrieval.

This PR provides solution for #2938, #2954.

This PR proposes the following model of Symfony2 framework module and client:

• module's $container is a read-only property. It returns active client's service container during test execution or self service container between tests when accessed externally.
• the module has $persistentServices array which contains services to persist between requests (kernel reboots) in a test.
• the module has $permanentServices array which contains services to persist between tests.
• persistence status of any service can be changed at any moment during test execution (public methods persistService(...) / unpersistService(...)).
• the app kernel is booted during module initialization in order to make framework features available before client creation.
• a client is created before each test. It is created based on current kernel, currently retrieved persistent services and a configuration option marking client's kernel rebootable between requests or not. Client's kernel is rebooted in its constructor to ensure clean environment for test.
• client's persistent services are being updated before kernel shutdown and injected into newly initialized service container after kernel boot during test execution.
• client's kernel can be rebooted using $I->rebootClientKernel() during test execution.
• permanent services are updated after test execution.
• cached router is permanent by default if used.
• doctrine's EM service is permanent by default.

Test results of Codeception's Symfony2 framework test app (https://github.com/Codeception/symfony-demo):

Test results of modified version of https://github.com/AlexStansfield/codeception-test - an application used to reproduce #2025:

Modifications to this test app include:

• creation of a copy of EntityCest.php - Entinty1Cest.php to check several cests in a suite,
• making some methods of EntityCest.php to perform several sendPOST(...) requests to check correct work and measure performance of a solution.

Performing tests with modified version of Codeception on my Symfony2 app showed memory consumption was around 190 Mb's (previously tests failed due to insufficient memory with a 3GB's configuration) and execution time became around 19 minutes (and even lower - 11 minutes - with config['cached_router'] = true)

This PR also includes:

• change retrieval of Doctrine's Entity Manager to make it compatible with new client generation logic and the model of persistent services and to avoid/solve Symfony2 and Doctrine2 entity manager issue after first test #2025, Doctrine 2 and unit of work #2853
• unification of service retrieval in existing public methods of Symfony2 module.

[Nitpick-CI]

Whitespace found at end of line

[Nitpick-CI]

Whitespace found at end of line

[raistlin]

You have removed my lasts commit, one that deprecated grabServiceFromContainer and introduces a new grabService.
Could you rebase please?

[raistlin]

How your modifications behave with current situation:

• You make a request that grab some data from Doctrine2, update entities or even create new entities and call persist but you do not call to flush
• You make other request. Will your second request see modifications done on first one?

[vyarmolenko]

There is no need to deprecate grabServiceFromContainer with proposed changes. The service is being retrieved from the appropriate container transparently.

We have persistent Entity Manager and Unit Of Work and in described situation all persist'ed entities become managed and preserved between requests. However as stated in doctrine/orm#5092 unflushed entities cannot be accessed in common way (eg something like$entity = $em->find('AppBundle:Codeception', $name) will return null for unflushed entity).
So the answer is yes, the second request can see modifications done by first one but with some restrictions (and it is a Doctrine issue, not Codeception's). The behaviour is the same as within one request.

[raistlin]

Rename of grabServiceFromContainer has been done to be consistent with other frameworks, that also have grabService.

[vyarmolenko]

Updated, please review.

[raistlin]

This var is not used, and is a breaking change.

[vyarmolenko]

We can make $container a read-only property and retrieve it with magic method __get($property) without breaking BC

[raistlin]

Ok, you can do it to handle the BC on 2.1.x. We should remove this 'magic' in a future release, maybe 3.0, and have only _getContainer.

[raistlin]

One last change: As this property no longer exists as is, please remove it from documentation.

[raistlin]

👍
Status: Reviewed.

[DavertMik]

Thanks, awesome work!