[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS #22675

ogizanagi · 2017-05-09T07:22:13Z

Q	A
Branch?	3.4
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#22668 (comment)
License	MIT
Doc PR	N/A

ogizanagi · 2017-05-09T07:25:15Z

src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

@@ -55,7 +55,7 @@ protected static function getPhpUnitXmlDir()

        // Can't continue
        if (null === $dir) {
-            throw new \RuntimeException('Unable to guess the Kernel directory.');
+            throw new \RuntimeException('Unable to guess the PHPUnit xml directory.');


I guess this method could be kept for BC and might somehow be useful. So I just update the exceptions messages rather than deprecating it too (same for getPhpUnitCliConfigArgument).
But what would be a proper exception message for:

if (!isset($_SERVER['argv']) || false === strpos($_SERVER['argv'][0], 'phpunit')) { throw new \RuntimeException('You must override the KernelTestCase::createKernel() method.'); }

some lines above (L.45) ?

XML instead of xml

julienfalque · 2017-05-09T07:39:06Z

UPGRADE-3.4.md

+
+ * Using `KERNEL_DIR` or the automatic guessing based on the `phpunit.xml` file
+   location is deprecated since 3.4. Either set `KERNEL_CLASS` in your `phpunit.xml` 
+   to he fully-qualified class name of your Kernel or override the `KernelTestCase::createKernel()` 


Typo: he => the.

ro0NL · 2017-05-09T08:02:01Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

+3.4.0
+-----
+
+* Deprecated not using the new `KERNEL_CLASS` server var with `KernelTestCase`.


Deprecated ``KERNEL_DIR`` ... ?

Not only. What is deprecated is the whole current method implementation, i.e KERNEL_DIR and the auto-detection based on phpunit.xml dir location. <=> Not using KERNEL_CLASS (it's better explained in the UPGRADE-3.4.md file. I believe it should stay short here)

If you override KernelTestCase::createKernel(), you (probably) don't use KERNEL_CLASS but you don't get a deprecation notice, this should be mentioned here as well. As this would make the sentence longer, I think @ro0NL's suggestions makes even more sense.

Fair enough. 😃

stof · 2017-05-09T09:57:32Z

UPGRADE-3.4.md

+ * Using `KERNEL_DIR` or the automatic guessing based on the `phpunit.xml` file
+   location is deprecated since 3.4. Either set `KERNEL_CLASS` in your `phpunit.xml` 
+   to the fully-qualified class name of your Kernel or override the `KernelTestCase::createKernel()` 
+   method. Not setting `KERNEL_CLASS` will throw an exception on 4.0.


can't we also overwrite getKernelClass() only ?

Yes indeed. I mean not setting KERNEL_CLASS when using the KernelTestCase::createKernel() base implementation. Of course if you overwrite it your on your own (and it's already suggested).
I don't know how to rephrase it better if the current version is not enough. I'll take any other suggestion.

EDIT: Sorry I misred your comment.

What about:

Using `KERNEL_DIR` or the automatic guessing based on the `phpunit.xml` file location is deprecated since 3.4. Set `KERNEL_CLASS` to the fully-qualified class name of your Kernel instead. Not setting `KERNEL_CLASS` will throw an exception on 4.0 unless you override `KernelTestCase::createKernel()` or `KernelTestCase::getKernelClass()` method.

I'll take this. Thank you @julienfalque

ogizanagi · 2017-05-10T06:25:18Z

I changed my mind about KernelTestCase::getPhpUnitXmlDir() and KernelTestCase::getPhpUnitCliConfigArgument() and I deprecated it as well (to be removed in 4.0). It's unlikely someone is using it for another reason (if it is, it's probably fragile) and has nothing to do in KernelTestCase once the current implementation of KernelTestCase::getKernelClass() is removed.

julienfalque · 2017-05-10T06:46:08Z

UPGRADE-4.0.md

@@ -331,6 +331,15 @@ FrameworkBundle
 * The `Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ValidateWorkflowsPass` class
   has been removed. Use the `Symfony\Component\Workflow\DependencyInjection\ValidateWorkflowsPass`
   class instead.
+
+ * The usage of `KERNEL_DIR` and the automatic guessing based on the `phpunit.xml` 
+   file location has been removed from `KernelTestCase::getKernelClass()` implementation. 


have been?

xabbuh · 2017-05-12T10:49:06Z

UPGRADE-3.4.md

+FrameworkBundle
+---------------
+
+ * Using `KERNEL_DIR` or the automatic guessing based on the `phpunit.xml` file


phpunit.xml/phpunit.xml.dist?

xabbuh · 2017-05-12T10:49:15Z

UPGRADE-3.4.md

+   exception on 4.0 unless you override `KernelTestCase::createKernel()` or
+   `KernelTestCase::getKernelClass()` method.
+
+ * Methods `KernelTestCase::getPhpUnitXmlDir()` and `KernelTestCase::getPhpUnitCliConfigArgument()`


The methods [...]

xabbuh · 2017-05-12T10:49:54Z

src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

     */
    private static function getPhpUnitCliConfigArgument()
    {
+        @trigger_error(sprintf('Method %s() is deprecated since 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);


The %s() method [...]

xabbuh · 2017-05-12T10:50:35Z

src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

@@ -112,6 +120,8 @@ protected static function getKernelClass()
            }

            return $class;
+        } else {
+            @trigger_error(sprintf('Using KERNEL_DIR or the automatic guessing based on the phpunit.xml file location is deprecated since 3.4. Set KERNEL_CLASS to the fully-qualified class name of your Kernel instead. Not setting KERNEL_CLASS will throw an exception on 4.0 unless you override %1$::createKernel() or %1$::getKernelClass() method.', static::class), E_USER_DEPRECATED);


Using the KERNEL_DIR environment variable [...]

Set the KERNEL_CLASS environment variable [...]

xabbuh · 2017-05-12T10:51:21Z

src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

     */
    protected static function getPhpUnitXmlDir()
    {
+        @trigger_error(sprintf('Method %s() is deprecated since 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);


The %s() method [...]

xabbuh · 2017-05-12T10:51:54Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

+3.4.0
+-----
+
+* Deprecated using `KERNEL_DIR` server var with `KernelTestCase::getKernelClass()`.


Deprecated using the KERNEL_DIR environment variable [...]

xabbuh · 2017-05-12T10:52:03Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

+-----
+
+* Deprecated using `KERNEL_DIR` server var with `KernelTestCase::getKernelClass()`.
+* Deprecated `KernelTestCase::getPhpUnitXmlDir()` and `KernelTestCase::getPhpUnitCliConfigArgument()` methods.


Deprecated the [...]

xabbuh · 2017-05-12T10:52:24Z

UPGRADE-4.0.md

+   override `KernelTestCase::createKernel()` or `KernelTestCase::getKernelClass()` 
+   method instead.
+
+ * Methods `KernelTestCase::getPhpUnitXmlDir()` and `KernelTestCase::getPhpUnitCliConfigArgument()`


The methods [...]

ogizanagi · 2017-05-12T17:04:11Z

Thanks for all the suggested improvements @xabbuh!

fabpot · 2017-06-09T00:37:27Z

Thank you @ogizanagi.

…KERNEL_CLASS (ogizanagi) This PR was merged into the 3.4 branch. Discussion ---------- [FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #22668 (comment) | License | MIT | Doc PR | N/A Commits ------- d102fc0 [FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS

…e (ogizanagi) This PR was merged into the 4.0-dev branch. Discussion ---------- [FrameworkBundle] Remove KernelTestCase deprecated code | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | no  | BC breaks? | yes | Deprecations? | no  | Tests pass? | yes | Fixed tickets | #22675 | License | MIT | Doc PR | N/A (failures unrelated) Commits ------- 6d28c43 [FrameworkBundle] Remove KernelTestCase deprecated code

carsonbot added Status: Needs Review FrameworkBundle Deprecation labels May 9, 2017

ogizanagi commented May 9, 2017

View reviewed changes

ogizanagi mentioned this pull request May 9, 2017

[FrameworkBundle] KernelTestCase: allow to provide the kernel class with a var #22668

Merged

julienfalque suggested changes May 9, 2017

View reviewed changes

ro0NL reviewed May 9, 2017

View reviewed changes

stof reviewed May 9, 2017

View reviewed changes

julienfalque reviewed May 10, 2017

View reviewed changes

javiereguiluz added this to the 3.4 milestone May 11, 2017

xabbuh reviewed May 12, 2017

View reviewed changes

ogizanagi changed the base branch from master to 3.4 May 17, 2017 18:31

[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS

d102fc0

fabpot approved these changes Jun 9, 2017

View reviewed changes

fabpot merged commit d102fc0 into symfony:3.4 Jun 9, 2017

ogizanagi deleted the deprec/3.4/kernel_test_case_kernel_dir branch June 9, 2017 06:10

ogizanagi mentioned this pull request Jun 13, 2017

[FrameworkBundle] Remove KernelTestCase deprecated code #23169

Merged

fabpot mentioned this pull request Oct 18, 2017

Release v3.4.0-BETA1 #24609

Merged

fabpot mentioned this pull request Oct 19, 2017

Release v4.0.0-BETA1 #24612

Merged

BPScott mentioned this pull request Dec 19, 2017

Changed $_SERVER to $_ENV in Test/WebTestCase.php liip/LiipFunctionalTestBundle#354

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS #22675

[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS #22675

ogizanagi commented May 9, 2017 •

edited

Loading

ogizanagi May 9, 2017

fabpot May 9, 2017

julienfalque May 9, 2017

ro0NL May 9, 2017

ogizanagi May 9, 2017 •

edited

Loading

julienfalque May 9, 2017

ogizanagi May 9, 2017

stof May 9, 2017

ogizanagi May 9, 2017 •

edited

Loading

julienfalque May 9, 2017

ogizanagi May 9, 2017

ogizanagi commented May 10, 2017

julienfalque May 10, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

xabbuh May 12, 2017

ogizanagi commented May 12, 2017

fabpot commented Jun 9, 2017

[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS #22675

[FrameworkBundle] KernelTestCase: deprecate not using KERNEL_CLASS #22675

Conversation

ogizanagi commented May 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi May 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi May 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi commented May 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogizanagi commented May 12, 2017

fabpot commented Jun 9, 2017

ogizanagi commented May 9, 2017 •

edited

Loading

ogizanagi May 9, 2017 •

edited

Loading

ogizanagi May 9, 2017 •

edited

Loading