fix: Email SMTP may throw Uncaught ErrorException

[kenjis]

Description
Fixes #3390

Checklist:

• Securely signed commits
• [] Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[kenjis]

@samsonasik The following refactoring breaks test code.

Method name is not configured

1) tests/system/Email/EmailTest.php:138

    ---------- begin diff ----------
@@ @@

     public function testDestructDoesNotThrowException()
     {
-        $email = $this->getMockBuilder(Email::class)
-            ->disableOriginalConstructor()
-            ->onlyMethods(['sendCommand'])
-            ->getMock();
+        $email = $this->createMock(Email::class);
         $email->method('sendCommand')
-            ->will($this->throwException(new ErrorException('SMTP Error.')));
+            ->willThrowException(new ErrorException('SMTP Error.'));

         // Force resource to be injected into the property
         $SMTPConnect = fopen(__FILE__, 'rb');
    ----------- end diff -----------

Applied rules:
 * GetMockBuilderGetMockToCreateMockRector
 * UseSpecificWillMethodRector

[samsonasik]

@kenjis could you create issue/failing test case on rector-phpunit repo? Should be bug on GetMockBuilderGetMockToCreateMockRector

[kenjis]

@samsonasik Created: rectorphp/rector-phpunit#86

[MGatner]

Looks good pending the Rector PR.

[paulbalandan]

We can use $this->createPartialMock(Email::class, ['sendCommand']); for brevity. I think this is what Rector should have done.

[kenjis]

We can use $this->createPartialMock(Email::class, ['sendCommand']); for brevity. I think this is what Rector should have done.

createPartialMock() uses setMethods() that is deprecated.
So using createPartialMock() changes the behavior.

[paulbalandan]

We can use $this->createPartialMock(Email::class, ['sendCommand']); for brevity. I think this is what Rector should have done.

createPartialMock() uses setMethods() that is deprecated. So using createPartialMock() changes the behavior.

createPartialMock is not deprecated. Only the implementation detail is deprecated. To this, it is not our job to check if the hidden implementation detail uses deprecated API if the API consuming this is not deprecated.

setMethods is effectively an onlyMethods, only in that onlyMethods check method existence first.

In PHPUnit 10, createPartialMock will use onlyMethods.
https://github.com/sebastianbergmann/phpunit/blob/52357158d80913d448a2ed89b54240f9d6fc07c3/src/Framework/TestCase.php#L1380-L1396

[kenjis]

@paulbalandan We and rector cannot use createPartialMock() in this case.
Because I'm using onlyMethods(), not setMethods().
In PHPUnit9 createPartialMock() has a bug due to historical reasons, and will be fixed in PHPUnit10.

[kenjis]

Rebased.

[MGatner]

I appreciate all the conversation and effort to figure out these complicated tests. I also want to acknowledge that Email should be deprecated in 4.3 and is already a bit of a shabby class. If we need to hack the class or skip testing altogether I'm fine with it.