Add support for PHPUnit 6 using class_alias in shim.php #4142

MontealegreLuis · 2017-04-18T21:21:12Z

I added support for PHPUnit 6 using class_alias as discussed in #3995

Tests are passing in Travis https://travis-ci.org/MontealegreLuis/Codeception/builds/223307775
I had to include PHPUnit_Util_Log_JSON, PHPUnit_Util_Log_TAP and PHP_Util_String in phpunit5-loggers.php given they were removed in PHPUnit 6.
There's a new method in the PHPUnit listener addWarning, so there are now 2 class definitions in Codeception\PHPUnit\Listener, one for PHPUnit 5 and another for 6, which are loaded conditionally.
Method setExpectedException was removed in PHPUnit 6 from PHPUnit\Framework\TestCase so I added it back to the classes that inherit from TestCase. It calls the parent method if it exists, otherwise it will call the new methods expectException, expectExceptionMessage, and expectExceptionCode.
UnitCept is checking for an exception class name so there's one more if statement there.

Thanks in advance!

* Add an empty implementation for the method addWarning, added to the TestListener interface in PHPUnit6 * Load this implementation only if PHPUnit 6 is being used, otherwise use the current implementation

* For PHPUnit 5 forward the call to the parent class. * For PHPUnit 6 use expectException, expectExceptionMessage, expectExceptionCode.

* Both the JSON and TAP loggers were removed in PHPUnit 6.

Added method to the following classes * MysqlTest, PostgresTest, MongoDbTest and RedisTest

…t 4.8

When using PHP 5.6 class_exists returns true for 'PHPUnit\Framework\TestCase'. PHUnit 6 can only be installed on PHP 7, now it's part of the main condition.

Nitpick-CI · 2017-04-18T21:21:18Z

phpunit5-loggers.php

+/**
+ * String helpers.
+ */
+class PHPUnit_Util_String


Each class must be in a namespace of at least one level (a top-level vendor name)

Class name PHPUnit_Util_String is not in camel caps format

Nitpick-CI · 2017-04-18T21:21:18Z

phpunit5-loggers.php

+/**
+ * A TestListener that generates JSON messages.
+ */
+class PHPUnit_Util_Log_JSON extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener


Each class must be in a file by itself

Each class must be in a namespace of at least one level (a top-level vendor name)

Class name PHPUnit_Util_Log_JSON is not in camel caps format

Nitpick-CI · 2017-04-18T21:21:19Z

phpunit5-loggers.php

+ * A TestListener that generates a logfile of the
+ * test execution using the Test Anything Protocol (TAP).
+ */
+class PHPUnit_Util_Log_TAP extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener


Each class must be in a file by itself

Each class must be in a namespace of at least one level (a top-level vendor name)

Class name PHPUnit_Util_Log_TAP is not in camel caps format

Nitpick-CI · 2017-04-18T21:21:19Z

src/Codeception/PHPUnit/Listener.php

+    }
+} else {
+    // Use PHPUnit 5 TestListener definition
+    class Listener implements \PHPUnit_Framework_TestListener


Each class must be in a file by itself

… list.

…s for PHPUnit classes.

* Added missing replacements.

* testFailedSeeInPopup was using annotations that were conflicting with the exception thrown when a test is skipped.

Naktibalda

Thanks, good job.
Please make a few more changes and it will be good to go.

Naktibalda · 2017-04-19T16:21:05Z

composer.json

@@ -18,8 +18,9 @@
        "php": ">=5.4.0 <8.0",
        "ext-json": "*",
        "ext-mbstring": "*",
-        "phpunit/phpunit": ">4.8.20 <6.0",
-        "phpunit/php-code-coverage": ">=2.2.4 <5.0",
+        "phpunit/phpunit": ">4.8.20 <6.1",


<7.0 should be fine, right?

I wasn't sure about this one, I read this comment on the issue #3995 (comment) and I tried to use a small range for the versions. If that's not a problem for you all, I can use a wider set of versions then.

Naktibalda · 2017-04-19T16:21:58Z

composer.json

-        "phpunit/php-code-coverage": ">=2.2.4 <5.0",
+        "phpunit/phpunit": ">4.8.20 <6.1",
+        "phpunit/php-code-coverage": ">=2.2.4 < 4.1 || ^5.0",
+        "phpunit/phpunit-mock-objects": ">2.3 <3.5 || ^4.0",


Have you got a reason to exclude php-code-coverage 4.1 and phpunit-mock-objects 3.5?

Same reason for this one. What would be your preferred set of values for these versions?

"phpunit/php-code-coverage": ">=2.2.4 < 6.0", "phpunit/phpunit-mock-objects": ">2.3 <5.0",

Naktibalda · 2017-04-19T16:22:44Z

composer.json

@@ -31,7 +32,7 @@
        "symfony/css-selector": ">=2.7 <4.0",
        "symfony/dom-crawler": ">=2.7.5 <4.0",
        "behat/gherkin": "~4.4.0",
-        "sebastian/comparator": "~1.1",
+        "sebastian/comparator": ">1.1 <1.2 || ^2.0",


Same here, why are you excluding 1.2?

I was just being cautious, as in the other ones. Please let me know what range would work better.

~1.1 actually allowed 1.2.* but you forbidden it.

">1.1 <3.0"

Naktibalda · 2017-04-19T16:34:57Z

shim.php

+// Add aliases for PHPUnit 6
+
+namespace {
+    if (version_compare(PHP_VERSION, '7.0.0') >= 0 && class_exists('PHPUnit\Framework\TestCase')) {


I think that if (!class_exists('PHPUnit_Framework_TestCase') && class_exists('PHPUnit\Framework\TestCase')) condition would be more accurate.

I found some weird behaviour when running the tests on PHP 5.6, which installs PHPUnit 5.7.*, I think. When I tried with the condition class_exists('PHPUnit\Framework\TestCase') it was returning true, which is incorrect, because this class is only present in PHPUnit 6, which can only be installed in PHP 7. I think it's because the class can be autoloaded. It's probably safe to check for PHP's version only.

It was a forward compatibility layer, wasn't it? that's why you need to check PHPUnit_Framework_TestCase.

Naktibalda · 2017-04-19T16:39:38Z

src/Codeception/PHPUnit/Listener.php

-     */
-    protected $dispatcher;
+// PHPUnit 6 definition for the TestListener class includes a new method `addWarning`
+if (interface_exists('PHPUnit\Framework\TestListener')) {


It is an overkill to provide 2 versions of the class, simply add addWarning method, it doesn't matter if it is missing in the earlier versions of the interface.

Yeah, now that I see it a second time, the solution was way simpler. I'll change it,

Naktibalda · 2017-04-19T16:43:57Z

src/Codeception/Test/Unit.php

+     */
+    public function setExpectedException($exception, $message = '', $code = null)
+    {
+        if (class_exists('PHPUnit\Framework\TestCase')) {


method_exists($this, 'expectException') is more accurate too, isn't it?

Yes, you're right I'll make the change.

Naktibalda · 2017-04-19T16:44:55Z

src/Codeception/Test/Unit.php

+        if (class_exists('PHPUnit\Framework\TestCase')) {
+            $this->expectException($exception);
+            $message !== '' && $this->expectExceptionMessage($message);
+            $code !== null && $this->expectExceptionCode($code);


Please don't do this, use if statement instead:

if ($message !== '') { $this->expectExceptionMessage($message); }

Ok, Ill change it.

Naktibalda · 2017-04-19T16:51:18Z

tests/unit/Codeception/Lib/Driver/MysqlTest.php

+     * If the method exists (PHPUnit 5) forward the call to the parent class, otherwise
+     * call `expectException` instead (PHPUnit 6)
+     */
+    public function setExpectedException($exception, $message = '', $code = null)


Ugh, you added this method to 8 test files.
The most elegant solution would be to migrate tests (all?) from PhpUnit_Framework_Testcase to Codeception\Test\Unit, but more pragmatic solution would be to add a trait.

There are some test classes not inheriting from Codeception\Test\Unit. That's why I didn't think of moving that method up. I think the trait is better. Unless you think that all those test should extend Codeception\Test\Unit.

Codeception\Test\Unit extends \PHPUnit_Framework_TestCase, so changing parent class should be straightforward. Please to update all tests if it doesn't cause any issues.

…plementations * Remove the path to this file from nitpick.json

…nit. * Remove duplicated method from all tests

* Check if the method expectException is present. * Use if statement instead of the && operator to call the other 2 methods.

Naktibalda · 2017-04-19T22:05:14Z

composer.json

-        "phpunit/php-code-coverage": ">=2.2.4 < 4.1 || ^5.0",
-        "phpunit/phpunit-mock-objects": ">2.3 <3.5 || ^4.0",
+        "phpunit/phpunit": ">4.8.20 <7.0",
+        "phpunit/php-code-coverage": ">=2.2.4 < 6.0",


Please delete that space between < and 6

Naktibalda

Thanks, good job.

DavertMik

Awesome! Thanks for your work. I'd definitely like to see it in next release.

DavertMik · 2017-04-20T22:14:36Z

src/Codeception/Test/Unit.php

+    public function setExpectedException($exception, $message = '', $code = null)
+    {
+        if (method_exists($this, 'expectException')) {
+            $this->expectException($exception);


We can show a deprecation method warning using https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Lib/Notification.php#L13

Does it make sense?

Thanks to all of you. I love this project! Yes, it makes sense. Is PHPUnit\Framework\TestCase::setExpectedException deprecated in favor of expectException, expectExceptionMessage, and expectExceptionCode a good message to use? This warning should only be shown when using PHPUnit 6 (not in the else of this condition)? Or it should be shown always (before the condition)?

@DavertMik it would show a lot of warnings for Codeception test suite, and we can't switch until we drop support for PHPUnit 4.

@MontealegreLuis I think that the warning should be shown if expectException exists.

Ok @Naktibalda will do that.

orlangur · 2017-04-22T19:17:36Z

Very bad implementation approach 😄

By the way, any idea why test suite is not compatible with PHPUnit 5.4? https://travis-ci.org/orlangur/Codeception/jobs/208363815

Naktibalda · 2017-04-22T19:27:07Z

@orlangur Please try 5.7

orlangur · 2017-04-22T19:31:37Z

@Naktibalda of course I can try... I'm trying to say that there are big holes in supported PHPUnit versions even before PHPUnit6 support with new hardcode.

So, it's better to drop PHPUnit 4, PHP <5.6 support and do some grooming instead of increasing fragility.

Naktibalda · 2017-04-22T19:36:42Z

Thanks for telling us.

We will do that in 2.3 or 3.0, whatever comes first.

Naktibalda · 2017-04-22T21:35:50Z

src/Codeception/Test/Unit.php

+     */
+    public function setExpectedException($exception, $message = '', $code = null)
+    {
+        if (method_exists($this, 'expectException')) {


This code does not match comments.
The matching code would be

if (is_callable('parent::setExpectedException')) { parent::setExpectedException($exception, $message, $code); } else { //... }

I'll change it.

This one and the deprecation warning are done.

Naktibalda · 2017-04-22T22:32:46Z

@MontealegreLuis As you may have noticed, your work is only a temporary measure.
A large part of it will have to be removed once we drop support for PHP <5.6 and PHPUnit <5.7
All use cases of shimmed classes will be replaced with new names and all deprecated method calls will be replaced with new method calls.
Would you like to do that as well?

MontealegreLuis · 2017-04-22T22:55:38Z

Sure thing, I'd love to do that!!

enumag · 2017-04-24T17:02:15Z

This looks like a good compromise until Codeception 3 is ready. Looking forward to see this in a stable release.

DavertMik · 2017-04-26T09:23:23Z

This PR will be part of Codeception 2.3
There still can be issues with PHP 6,0 support so If they happen we encourage to restrict to phpunit ^5.7.0 manually in composer.json

GwendolenLynch · 2017-05-23T04:25:52Z

I see 2.3.0 was just released, but without the changes to composer.json to re-enable the higher constraint… will this be a 2.4 target now?

Naktibalda · 2017-05-23T09:07:11Z

@DavertMik This was a driver for 2.3.0 and you missed it. Can it go out in 2.3.1?

DavertMik · 2017-05-23T10:49:15Z

No, it was announced for 2.3 so it should be there. Looks like there was a merge which reverted the constraints. I will update it today 23 трав. 2017 р. 07:25 "Gawain Lynch" <notifications@github.com> пише:

…

I see 2.3.0 was just released, but without the changes to composer.json <https://github.com/Codeception/Codeception/blob/2.3.0/composer.json#L21> to re-enable the higher constraint… will this be a 2.4 target now? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4142 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANcaAN_be5EHTNW6n_BrJRGrvpr-OfEks5r8l_RgaJpZM4NA6UC> .

MontealegreLuis added 9 commits April 17, 2017 14:59

Modify version constraints to allow the installation of PHPUnit 6.

39e14ba

Add aliases for PHPUnit 6.

306f7ca

Use an updated implementation of TestListener for PHPUnit 6

e83b690

* Add an empty implementation for the method addWarning, added to the TestListener interface in PHPUnit6 * Load this implementation only if PHPUnit 6 is being used, otherwise use the current implementation

Add shim for method setExpectedException

138e1db

* For PHPUnit 5 forward the call to the parent class. * For PHPUnit 6 use expectException, expectExceptionMessage, expectExceptionCode.

Add shim file for loggers removed in PHPUnit 6

93bbd64

* Both the JSON and TAP loggers were removed in PHPUnit 6.

Class name for exception is different for PHPUnit 6.

8d200f9

Add missing setExpectedException method.

4baa1d9

Added method to the following classes * MysqlTest, PostgresTest, MongoDbTest and RedisTest

Fix version constraint for the mock-objects package when using PHPUni…

007103a

…t 4.8

Check PHP version in shim.php.

b09e7dd

When using PHP 5.6 class_exists returns true for 'PHPUnit\Framework\TestCase'. PHUnit 6 can only be installed on PHP 7, now it's part of the main condition.

Nitpick-CI reviewed Apr 18, 2017

View reviewed changes

MontealegreLuis added 4 commits April 18, 2017 20:43

Add phpunit5-loggers.php and the PHPUnit listener to Nitpick's ignore…

e0ad583

… list.

Fix class names in WebDriverTest use underscores instead of namespace…

ae3f359

…s for PHPUnit classes.

Replace namespaces with underscores.

ac1ba42

* Added missing replacements.

Use method setExpectedException instead of the annotations.

0a972ef

* testFailedSeeInPopup was using annotations that were conflicting with the exception thrown when a test is skipped.

Naktibalda requested changes Apr 19, 2017

View reviewed changes

MontealegreLuis added 5 commits April 19, 2017 13:26

Add method addWarning to Listener instead of providing 2 different im…

4f20990

…plementations * Remove the path to this file from nitpick.json

Change tests using setExpectedException to inherit Codeception/Test/U…

1df1b81

…nit. * Remove duplicated method from all tests

Use method_exists instead of class_exists

43ed899

* Check if the method expectException is present. * Use if statement instead of the && operator to call the other 2 methods.

Fix versions range for PHPUnit related packages.

9080fe0

Improve the readability of the condition to add the classes alias

ffd1fa6

Naktibalda reviewed Apr 19, 2017

View reviewed changes

Remove extra space in version constraint.

d3acef7

Naktibalda approved these changes Apr 20, 2017

View reviewed changes

Naktibalda requested a review from DavertMik April 20, 2017 20:42

DavertMik approved these changes Apr 20, 2017

View reviewed changes

Naktibalda requested changes Apr 22, 2017

View reviewed changes

MontealegreLuis added 2 commits April 22, 2017 18:22

Add deprecation warning when using PHPUnit 6.

0d9eff4

Invert if statement to better match the comment description.

2f06caa

Naktibalda approved these changes Apr 25, 2017

View reviewed changes

Naktibalda merged commit 503f1fe into Codeception:2.2 Apr 25, 2017

Naktibalda mentioned this pull request Apr 25, 2017

Support for PHPUnit 6.0 #3995

Closed

Add support for PHPUnit 6 using class_alias in shim.php #4142

Add support for PHPUnit 6 using class_alias in shim.php #4142

Conversation

MontealegreLuis commented Apr 18, 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

Naktibalda left a 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

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

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

Naktibalda left a comment

Choose a reason for hiding this comment

DavertMik left a 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

orlangur commented Apr 22, 2017

Naktibalda commented Apr 22, 2017

orlangur commented Apr 22, 2017

Naktibalda commented Apr 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Naktibalda commented Apr 22, 2017

MontealegreLuis commented Apr 22, 2017

enumag commented Apr 24, 2017

DavertMik commented Apr 26, 2017

GwendolenLynch commented May 23, 2017

Naktibalda commented May 23, 2017

DavertMik commented May 23, 2017 via email