Merge pull request #136 from robertpustulka/email-transport

Email transport configuration enhancements

Author: markstory

src/Job/SendMailJob.php

@@ -18,6 +18,7 @@
 
 use Cake\Log\Log;
 use Cake\Mailer\AbstractTransport;
+use Cake\Mailer\TransportFactory;
 use Cake\Queue\Queue\Processor;
 
 /**
@@ -65,12 +66,15 @@ public function execute(Message $message): ?string
      */
     protected function getTransport(string $transportClassName, array $config): AbstractTransport
     {
+        if ($transportClassName === '') {
+            throw new \InvalidArgumentException('Transport class name is empty.');
+        }
+
         if (
-            empty($transportClassName) ||
             !class_exists($transportClassName) ||
             !method_exists($transportClassName, 'send')
         ) {
-            throw new \InvalidArgumentException(sprintf('Transport class name is not valid: %s', $transportClassName));
+            return TransportFactory::get($transportClassName);
         }
 
         $transport = new $transportClassName($config);

src/Mailer/Transport/QueueTransport.php

@@ -85,7 +85,7 @@ protected function prepareData(Message $message): array
     {
         return [
             'transport' => $this->getConfig('transport'),
-            'config' => $this->getConfig(),
+            'config' => is_array($this->getConfig('config')) ? $this->getConfig('config') : $this->getConfig(),
             'emailMessage' => json_encode($message),
         ];
     }

tests/TestCase/Job/SendMailJobTest.php

@@ -18,6 +18,7 @@
 
 use Cake\Mailer\Mailer;
 use Cake\Mailer\Transport\DebugTransport;
+use Cake\Mailer\TransportFactory;
 use Cake\Queue\Job\Message;
 use Cake\Queue\Job\SendMailJob;
 use Cake\Queue\Queue\Processor;
@@ -78,6 +79,32 @@ public function testExecute()
         $this->assertSame(Processor::ACK, $actual);
     }
 
+    /**
+     * Test execute method with transport name
+     *
+     * @return void
+     */
+    public function testExecuteTransportName()
+    {
+        $job = new SendMailJob();
+        $message = $this->createMessage('foo', [], $this->message);
+        $emailMessage = new \Cake\Mailer\Message();
+        $data = json_decode($message->getArgument('emailMessage'), true);
+        $emailMessage->createFromArray($data);
+
+        $transport = $this->getMockBuilder(DebugTransport::class)->getMock();
+        $transport->expects($this->once())
+            ->method('send')
+            ->with($emailMessage)
+            ->willReturn(['message' => 'test', 'headers' => []]);
+        TransportFactory::getRegistry()->set('foo', $transport);
+
+        $actual = $job->execute($message);
+        $this->assertSame(Processor::ACK, $actual);
+
+        TransportFactory::drop('foo');
+    }
+
     /**
      * Test execute with attachments method
      *

tests/TestCase/Mailer/Transport/QueueTransportTest.php

@@ -16,12 +16,26 @@
  */
 namespace Cake\Queue\Test\TestCase\Job;
 
+use Cake\Mailer\Message;
+use Cake\Mailer\Transport\SmtpTransport;
 use Cake\Queue\Mailer\Transport\QueueTransport;
 use Cake\Queue\QueueManager;
 use Cake\TestSuite\TestCase;
 
 class QueueTransportTest extends TestCase
 {
+    private $fsQueuePath = TMP . DS . 'queue';
+
+    private function getFsQueueUrl(): string
+    {
+        return 'file:///' . $this->fsQueuePath;
+    }
+
+    private function getFsQueueFile(): string
+    {
+        return $this->getFsQueueUrl() . DS . 'enqueue.app.default';
+    }
+
     /**
      * Test send
      *
@@ -31,9 +45,9 @@ public function testSend()
     {
         QueueManager::setConfig('default', [
             'queue' => 'default',
-            'url' => 'null:',
+            'url' => $this->getFsQueueUrl(),
         ]);
-        $message = (new \Cake\Mailer\Message())
+        $message = (new Message())
             ->setFrom('[email protected]')
             ->setTo('[email protected]')
             ->setSubject('Sample Subject');
@@ -58,6 +72,83 @@ public function testSend()
 
         $expected = ['headers' => $headers, 'message' => 'Message has been enqueued'];
         $this->assertEquals($expected, $result);
+
+        $fsQueueFile = $this->getFsQueueFile();
+        $this->assertFileExists($fsQueueFile);
+
+        $content = file_get_contents($fsQueueFile);
+        $this->assertStringContainsString('MailTransport', $content);
+
+        QueueManager::drop('default');
+    }
+
+    /**
+     * Test send custom transport
+     *
+     * @return void
+     */
+    public function testSendCustomTransport()
+    {
+        QueueManager::setConfig('default', [
+            'queue' => 'default',
+            'url' => $this->getFsQueueUrl(),
+        ]);
+        $message = (new Message());
+
+        $transport = new QueueTransport([
+            'transport' => SmtpTransport::class,
+            'config' => [
+                'host' => 'mail.example.com',
+            ],
+        ]);
+        $transport->send($message);
+
+        $fsQueueFile = $this->getFsQueueFile();
+        $this->assertFileExists($fsQueueFile);
+
+        $content = file_get_contents($fsQueueFile);
+        $this->assertStringContainsString('SmtpTransport', $content);
+        $this->assertStringContainsString('"config\":{\"host\":\"mail.example.com\"}', $content);
+
         QueueManager::drop('default');
     }
+
+    /**
+     * Test send backwards compatibility transport config
+     *
+     * @return void
+     */
+    public function testSendBcTransport()
+    {
+        QueueManager::setConfig('default', [
+            'queue' => 'default',
+            'url' => $this->getFsQueueUrl(),
+        ]);
+        $message = (new Message());
+
+        $transport = new QueueTransport([
+            'transport' => SmtpTransport::class,
+            'host' => 'mail.example.com',
+        ]);
+        $transport->send($message);
+
+        $fsQueueFile = $this->getFsQueueFile();
+        $this->assertFileExists($fsQueueFile);
+
+        $content = file_get_contents($fsQueueFile);
+        $this->assertStringContainsString('SmtpTransport', $content);
+        $this->assertStringContainsString('"host\":\"mail.example.com\"', $content);
+
+        QueueManager::drop('default');
+    }
+
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        $fsQueueFile = $this->getFsQueueFile();
+        if (file_exists($fsQueueFile)) {
+            unlink($fsQueueFile);
+        }
+    }
 }