[PhpUnit] new PhpUnit bridge #13398

nicolas-grekas · 2015-01-13T14:33:39Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#13644
License	MIT
Doc PR	-

From the proposed README:

PHPUnit Bridge

Provides utilities for PHPUnit, especially user deprecation notices management.

It comes with the following features:

disable the garbage collector;
auto-register class_exists to load Doctrine annotations;
print a user deprecation notices summary at the end of the test suite.

Handling user deprecation notices is sensitive to the SYMFONY_DEPRECATIONS_HELPER
environment variable. This env var configures 3 behaviors depending on its value:

when set to strict, all but legacy-tagged deprecation notices will make tests
fail. This is the recommended mode for best forward compatibility.
weak on the contrary will make tests ignore all deprecation notices.
This is the recommended mode for legacy projects that must use deprecated
interfaces for backward compatibility reasons.
any other value will respect the current error reporting level.

All three modes will display a summary of deprecation notices at the end of the
test suite, split in two groups:

Legacy deprecation notices denote tests that explicitly test some legacy
interfaces. In all 3 modes, deprecation notices triggered in a legacy-tagged
test do never make a test fail. There are four ways to mark a test as legacy:
- make its class start with the Legacy prefix;
- make its method start with testLegacy;
- make its data provider start with provideLegacy or getLegacy;
- add the @group legacy annotation to its class or method.
Remaining/Other deprecation notices are all other (non-legacy)
notices, grouped by message, test class and method.

Usage

Add this bridge to the require-dev section of your composer.json file
(not in require) with e.g.
composer require --dev "symfony/phpunit-bridge".

When running phpunit, you will see a summary of deprecation notices at the end
of the test suite.

Deprecation notices in the Remaining/Other section need some thought.
You have to decide either to:

update your code to not use deprecated interfaces anymore, thus gaining better
forward compatibility;
or move them to the Legacy section (by using one of the above way).

After reviewing them, you should silence deprecations in the Legacy section
if you think they are triggered by tests dedicated to testing deprecated
interfaces. To do so, add the following line at the beginning of your legacy
test case or in the setUp() method of your legacy test class:
$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);

Last but not least, you should then configure your C.I. to the reporting mode
that is appropriated to your project by setting SYMFONY_DEPRECATIONS_HELPER to
strict, weak or empty. It is recommended to start with weak mode, upgrade
your code as described above, then when the Remaining/Other sections are empty,
move to strict to keep forward compatibility on the long run.

nicolas-grekas · 2015-01-13T14:34:42Z

src/Symfony/Component/Testing/composer.json

+        }
+    ],
+    "require": {
+        "php": ">=5.3.3"


Not 5.3.9 to allow standalone reuse on older projects

stof · 2015-01-13T14:37:22Z

src/Symfony/Component/Testing/DeprecationErrorHandler.php

-AnnotationRegistry::registerLoader(array($loader, 'loadClass'));
+    private static function hasColorSupport()
+    {
+        if (DIRECTORY_SEPARATOR == '\\') {


should be ===

stof · 2015-01-13T14:38:57Z

src/Symfony/Component/Testing/composer.json

+    },
+    "autoload": {
+        "psr-0": { "Symfony\\Component\\Testing\\": "" },
+        "files": [ "bootstrap.php" ]


this seems wrong to me. You want the bootstrap.php file to be loaded only when running the testsuite of your project, not when running your project locally (and you don't want to need to reinstall the project without dev requirements all the time during development

xelaris · 2015-01-13T20:47:49Z

src/Symfony/Component/Testing/composer.json

+        }
+    ],
+    "require": {
+        "php": ">=5.3.3"


">=5.3.9" is requirement since 6dc8979

sorry, I overlooked the original comment on the "outdated diff", where it is sated that it is intentionally, so my last comment can be ignored

wouterj · 2015-01-14T11:03:43Z

src/Symfony/Component/Testing/composer.json

+    },
+    "autoload-dev": {
+        "files": [ "Resources/bootstrap/symfony.php" ]
+    },


you are aware that this won't be used when the package is required in another package? Dev config will only be tracked when the package is the root package.

wouterj · 2015-01-14T11:05:10Z

I don't like it's name, as it doesn't really provide much testing help apart from easing the transition between 2.x and 3.x. Maybe we're going to need more utilities for this transition, what about renaming this component to have all this utilities?

…reak the build if we treat deprecated as an error

nicolas-grekas · 2015-02-11T18:08:49Z

Talking a bit with some others, I'm going to move this to src/Symfony/Bridge/PhpUnit

GromNaN · 2015-02-12T23:12:03Z

src/Symfony/Bridge/PhpUnit/bootstrap.php

+
+if (class_exists('Doctrine\Common\Annotations\AnnotationRegistry')) {
+    AnnotationRegistry::registerLoader('class_exists');
+}


You should add MongoDB annotations too.
http://symfony.com/doc/current/bundles/DoctrineMongoDBBundle/index.html#register-the-annotations-and-the-bundle

not needed. The MongoDB annotations are autoloadable, so this is enough to register them (registering class_exists in the AnnotationRegistry is enough as long as all your autoloaders are handling properly the case of a non-existant class, i.e. not breaking class_exists)

nicolas-grekas · 2015-02-17T21:59:57Z

README updated

wouterj · 2015-02-17T22:10:22Z

src/Symfony/Bridge/PhpUnit/composer.json

+        "psr-0": { "Symfony\\Bridge\\PhpUnit\\": "" }
+    },
+    "target-dir": "Symfony/Bridge/PhpUnit",
+    "minimum-stability": "dev",


this seems a bit odd, as it has no dependencies

fabpot · 2015-02-18T10:28:34Z

src/Symfony/Bridge/PhpUnit/README.md

+PHPUnit Bridge
+==============
+
+Utilities for PHPUnit, especially user deprecation notices management.


I'm pretty sure that it was not what I proposed. We have a uniform way to describe each component in one sentence. So, it should be Provides utilities ...

fabpot · 2015-02-18T10:32:35Z

src/Symfony/Bridge/PhpUnit/README.md

+
+Provides utilities for PHPUnit, especially user deprecation notices management.
+
+It comesa with the following features:


typo comes

Tobion · 2015-02-19T00:29:03Z

src/Symfony/Bridge/PhpUnit/composer.json

+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Nicolas Grekas",


Not sure what approach we are following here. But Form and PropertyAccess Component for example created by Bernhard have Fabien as author. So it's kinda inconsistent. I guess we should either only add the Symfony Community, or maybe all Mergers as author. This way it also helps as reference to find a contact person.

As a matter of fact, I'm the author of this component... @fabpot is the copyright owner mentionned in the LICENSE file, but I wrote the code. This is just plain descriptive truth. If someone else wrote some other component (or a significant non-trivial part of it), he/she should also be mentionned as author IMHO.

This is fine because he already had things like this merged https://github.com/symfony/symfony/blob/2.7/src/Symfony/Component/VarDumper/composer.json#L10 and it just makes sense. If the other components were attributed to @fabpot well that is because it was ok with their authors perhaps.

nicolas-grekas · 2015-02-19T09:32:29Z

Please note that I modified the .travis file to ignore tests in the legacy group. There are no tests tagged @group legacy right now, but this should happen because when removing legacy interface from 3.0, the legacy tests will not work anymore, when a 2.7 test uses a 3.0 component.
We could even add the annotation in all legacy tests right now. What do you think about it?

cordoval · 2015-02-19T13:12:47Z

src/Symfony/Bridge/PhpUnit/README.md

+
+ * disable the garbage collector;
+ * auto-register `class_exists` to load Doctrine annotations;
+ * print a user deprecation notices summary at the end of the test suite.


test suite output?

fabpot · 2015-02-21T08:38:17Z

Thank you @nicolas-grekas.

This PR was merged into the 2.7 branch. Discussion ---------- [PhpUnit] new PhpUnit bridge | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #13644 | License | MIT | Doc PR | - From the proposed README: PHPUnit Bridge ============== Provides utilities for PHPUnit, especially user deprecation notices management. It comes with the following features: * disable the garbage collector; * auto-register `class_exists` to load Doctrine annotations; * print a user deprecation notices summary at the end of the test suite. Handling user deprecation notices is sensitive to the SYMFONY_DEPRECATIONS_HELPER environment variable. This env var configures 3 behaviors depending on its value: * when set to `strict`, all but legacy-tagged deprecation notices will make tests fail. This is the recommended mode for best forward compatibility. * `weak` on the contrary will make tests ignore all deprecation notices. This is the recommended mode for legacy projects that must use deprecated interfaces for backward compatibility reasons. * any other value will respect the current error reporting level. All three modes will display a summary of deprecation notices at the end of the test suite, split in two groups: * **Legacy** deprecation notices denote tests that explicitly test some legacy interfaces. In all 3 modes, deprecation notices triggered in a legacy-tagged test do never make a test fail. There are four ways to mark a test as legacy: - make its class start with the `Legacy` prefix; - make its method start with `testLegacy`; - make its data provider start with `provideLegacy` or `getLegacy`; - add the `@group legacy` annotation to its class or method. * **Remaining/Other** deprecation notices are all other (non-legacy) notices, grouped by message, test class and method. Usage ----- Add this bridge to the `require-dev` section of your composer.json file (not in `require`) with e.g. `composer require --dev "symfony/phpunit-bridge"`. When running `phpunit`, you will see a summary of deprecation notices at the end of the test suite. Deprecation notices in the **Remaining/Other** section need some thought. You have to decide either to: * update your code to not use deprecated interfaces anymore, thus gaining better forward compatibility; * or move them to the **Legacy** section (by using one of the above way). After reviewing them, you should silence deprecations in the **Legacy** section if you think they are triggered by tests dedicated to testing deprecated interfaces. To do so, add the following line at the beginning of your legacy test case or in the `setUp()` method of your legacy test class: `$this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);` Last but not least, you should then configure your C.I. to the reporting mode that is appropriated to your project by setting SYMFONY_DEPRECATIONS_HELPER to `strict`, `weak` or empty. It is recommended to start with `weak` mode, upgrade your code as described above, then when the *Remaining/Other* sections are empty, move to `strict` to keep forward compatibility on the long run. Commits ------- acac734 [PhpUnitBridge] new bridge for testing with PHPUnit

nicolas-grekas reviewed Jan 13, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch from e9d43d7 to 4456d31 Compare January 13, 2015 14:36

stof reviewed Jan 13, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch from 4456d31 to f0458c2 Compare January 13, 2015 14:38

stof reviewed Jan 13, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch 2 times, most recently from 8e58ddf to 25b69fd Compare January 13, 2015 14:54

xelaris reviewed Jan 13, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch from 25b69fd to 1f79a32 Compare January 14, 2015 08:15

wouterj reviewed Jan 14, 2015
View reviewed changes

wouterj referenced this pull request in FriendsOfSymfony/FOSHttpCacheBundle Jan 21, 2015

Symfony 2.7 calls its own deprecated methods, raising warnings that b…

f227d42

…reak the build if we treat deprecated as an error

phiamo mentioned this pull request Jan 21, 2015

Fix travis for SF >=2.7 phiamo/MopaBootstrapBundle#1024

Closed

nicolas-grekas changed the title ~~[Testing] new testing component~~ [PhpUnit] new PhpUnit bridge Feb 11, 2015

nicolas-grekas force-pushed the testing-component branch 4 times, most recently from 2322d42 to 1d35ce6 Compare February 11, 2015 22:15

GromNaN reviewed Feb 12, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch 2 times, most recently from c636b94 to 5345d98 Compare February 16, 2015 10:02

nicolas-grekas force-pushed the testing-component branch from 18aced3 to 533a9b3 Compare February 17, 2015 21:59

wouterj reviewed Feb 17, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch 4 times, most recently from 20c61f3 to 5124a11 Compare February 18, 2015 06:57

fabpot reviewed Feb 18, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch from 5124a11 to 6b95d85 Compare February 18, 2015 10:31

fabpot reviewed Feb 18, 2015
View reviewed changes

nicolas-grekas force-pushed the testing-component branch from 6b95d85 to 1940dc9 Compare February 18, 2015 10:33

[PhpUnitBridge] new bridge for testing with PHPUnit

acac734

nicolas-grekas force-pushed the testing-component branch from 1940dc9 to acac734 Compare February 18, 2015 10:38

Tobion reviewed Feb 19, 2015
View reviewed changes

cordoval reviewed Feb 19, 2015
View reviewed changes

fabpot merged commit acac734 into symfony:2.7 Feb 21, 2015

nicolas-grekas deleted the testing-component branch March 1, 2015 10:12

xabbuh mentioned this pull request Mar 5, 2015

Documentation for the new PhpUnit bridge symfony/symfony-docs#5059

Closed

stof mentioned this pull request Mar 22, 2015

[WIP] Stop ignoring deprecations #13652

Closed


		Provides utilities for PHPUnit, especially user deprecation notices management.

		It comesa with the following features:

Uh oh!

[PhpUnit] new PhpUnit bridge #13398

[PhpUnit] new PhpUnit bridge #13398

Uh oh!

Conversation

nicolas-grekas commented Jan 13, 2015

PHPUnit Bridge

Usage

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wouterj commented Jan 14, 2015

Uh oh!

nicolas-grekas commented Feb 11, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Feb 17, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Feb 19, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot commented Feb 21, 2015

Uh oh!

Uh oh!