Merge pull request #69 from dotkernel/issue-68

Added declare strict types to config file

config/mail.global.php.dist

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
 
     /**
@@ -57,17 +59,15 @@ return [
                 //body options - content can be plain text, HTML
                 'body' => [
                     'content' => '',
-
                     'charset' => 'utf-8',
                 ],
 
                 //attachments config
                 'attachments' => [
                     'files' => [],
-
-                    'dir' => [
-                        'iterate' => false,
-                        'path' => 'data/mail/attachments',
+                    'dir'   => [
+                        'iterate'   => false,
+                        'path'      => 'data/mail/attachments',
                         'recursive' => false,
                     ]
                 ],
@@ -89,10 +89,10 @@ return [
                 'connection_config' => [
 
                     //the smtp authentication identity
-                    //'username' => '',
+                    'username' => '',
 
                     //the smtp authentication credential
-                    //'password' => '',
+                    'password' => '',
 
                     //the encryption type to be used, ssl or tls
                     //null should be used to disable SSL

src/Factory/AbstractMailFactory.php

@@ -30,11 +30,8 @@ abstract class AbstractMailFactory implements AbstractFactoryInterface
     public function canCreate(ContainerInterface $container, $requestedName): bool
     {
         $parts = explode('.', $requestedName);
-        if (count($parts) !== 3) {
-            return false;
-        }
 
-        if ($parts[0] !== self::DOT_MAIL_PART || $parts[1] !== static::SPECIFIC_PART) {
+        if ($parts[0] !== self::DOT_MAIL_PART || $parts[1] !== static::SPECIFIC_PART || count($parts) !== 3) {
             return false;
         }
 

test/CommonTrait.php

@@ -88,20 +88,22 @@ private function generateConfig(): array
                     //options that will be used only if Symfony\Component\Mailer\Transport\Smtp\SmtpTransport
                     // adapter is used
                     'smtp_options' => [
-                        'host'              => 'qwd',
+                        'host'              => 'testHost',
                         'port'              => 587,
                         'connection_class'  => 'login',
                         'connection_config' => [
 
                             //the smtp authentication identity
-                            'username' => 'qwd',
+                            'username' => 'test',
 
                             //the smtp authentication credential
-                            'password' => 'qwd',
+                            'password' => 'testPassword',
                             'ssl'      => 'tls',
                         ],
                     ],
                 ],
+                'test'    => 'string test',
+
                 // option to log the SENT emails
                 'log' => [
                     'sent' => $this->fileSystem->url() . '/log/mail/sent.log',

test/EmailTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DotTest\Mail;
+
+use DateTimeImmutable;
+use Dot\Mail\Email;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Exception\LogicException;
+
+class EmailTest extends TestCase
+{
+    public function testGettersAndSetters(): void
+    {
+        $subject = new Email();
+
+        $subject->date(new DateTimeImmutable('now'));
+        $subject->returnPath('[email protected]');
+        $subject->setSender('[email protected]', 'testSender');
+        $subject->addFrom(['[email protected]', '[email protected]'], 'testAddFrom');
+        $subject->setFrom('[email protected]', 'testSetFrom');
+        $subject->addReplyTo('[email protected]', 'testAddReplyTo');
+        $subject->setReplyTo('[email protected]', 'testSetReplyTo');
+        $subject->addTo('[email protected]', 'testAddTo');
+        $subject->setTo('[email protected]', 'testAddTo');
+        $subject->addCc('[email protected]', 'testAddCc');
+        $subject->setCc(new Address('[email protected]'), 'testSetBcc');
+        $subject->addBcc('[email protected]', 'testAddBcc');
+        $subject->setBcc('[email protected]', 'testSetBcc');
+        $subject->priority(6);
+        $subject->text('test text body');
+        $subject->html('test html body');
+        $subject->setEncoding('UTF-8');
+
+        $this->assertInstanceOf(DateTimeImmutable::class, $subject->getDate());
+        $this->assertInstanceOf(Address::class, $subject->getReturnPath());
+        $this->assertInstanceOf(Address::class, $subject->getSender());
+        $this->assertIsArray($subject->getFrom());
+        $this->assertIsArray($subject->getReplyTo());
+        $this->assertIsArray($subject->getTo());
+        $this->assertIsArray($subject->getCc());
+        $this->assertIsArray($subject->getBcc());
+        $this->assertIsInt($subject->getPriority());
+        $this->assertIsString($subject->getTextBody());
+        $this->assertIsString($subject->getHtmlBody());
+        $this->assertIsString($subject->getEncoding());
+        $this->assertIsString($subject->getHtmlCharset());
+        $this->assertIsString($subject->getTextCharset());
+    }
+
+    public function testEnsureBodyValidity(): void
+    {
+        $subject = new Email();
+        $this->expectException(LogicException::class);
+        $subject->ensureValidity();
+    }
+
+    public function testEnsureValidity(): void
+    {
+        $subject = new Email();
+        $subject->html('test html body');
+        $subject->getHeaders()->addHeader('X-Unsent', '1');
+
+        $this->expectException(LogicException::class);
+        $subject->ensureValidity();
+    }
+}

test/Factory/AbstractMailFactoryTest.php

@@ -63,4 +63,18 @@ public function testCanCreateRequestedService(): void
         $result = $this->subject->canCreate($container, $requestedName);
         $this->assertTrue($result);
     }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws Exception
+     * @throws NotFoundExceptionInterface
+     */
+    public function testWillNotCreateRequestedNameFromWrongParts(): void
+    {
+        $container     = $this->createMock(ContainerInterface::class);
+        $requestedName = 'dot-mail.testPart.default.test';
+
+        $result = $this->subject->canCreate($container, $requestedName);
+        $this->assertFalse($result);
+    }
 }

test/Factory/MailOptionsAbstractFactoryTest.php

@@ -55,4 +55,24 @@ public function testGeneratesMailOptions(): void
 
         $this->assertInstanceOf(MailOptions::class, $subject);
     }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws Exception
+     * @throws NotFoundExceptionInterface
+     */
+    public function testIsSpecificConfigArray(): void
+    {
+        $defaultName = 'dot-mail.options.test';
+        $container   = $this->createMock(ContainerInterface::class);
+
+        $container->expects($this->once())
+            ->method('get')
+            ->with('config')
+            ->willReturn($this->config);
+
+        $subject = (new MailOptionsAbstractFactory())($container, $defaultName);
+
+        $this->assertInstanceOf(MailOptions::class, $subject);
+    }
 }

test/Factory/MailServiceAbstractFactoryTest.php

@@ -5,6 +5,7 @@
 namespace DotTest\Mail\Factory;
 
 use Dot\Mail\Event\AbstractMailEventListener;
+use Dot\Mail\Exception\InvalidArgumentException;
 use Dot\Mail\Exception\RuntimeException;
 use Dot\Mail\Factory\MailServiceAbstractFactory as Subject;
 use Dot\Mail\Options\AttachmentsOptions;
@@ -202,4 +203,61 @@ public function testGenerateServiceWithoutProvidedAdapter(): void
         $this->assertInstanceOf(SmtpTransport::class, $mailService->getTransport());
         $this->assertCount(2, $mailService->getAttachments());
     }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws Exception
+     * @throws NotFoundExceptionInterface
+     */
+    public function testGenerateServiceInvalidAdapter(): void
+    {
+        $requestedName = 'dot-mail.service.default';
+
+        $this->mailOptions->expects($this->any())
+            ->method('getTransport')
+            ->willReturn('test');
+
+        $this->container->expects($this->atLeastOnce())
+            ->method('get')
+            ->willReturnMap([
+                ['dot-mail.options.default', $this->mailOptions],
+                [LogServiceInterface::class, $this->createMock(LogService::class)],
+                ['Invalid Listener Test', 'Invalid Listener provided'],
+            ]);
+
+        $this->expectException(InvalidArgumentException::class);
+        (new Subject())($this->container, $requestedName);
+    }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws Exception
+     * @throws NotFoundExceptionInterface
+     */
+    public function testGenerateServiceThrowException(): void
+    {
+        $requestedName = 'dot-mail.service.default';
+
+        $this->mailOptions->expects($this->any())
+            ->method('getTransport')
+            ->willReturn(InvalidArgumentException::class);
+
+        $this->container->expects($this->atLeastOnce())
+            ->method('get')
+            ->willReturnMap([
+                ['dot-mail.options.default', $this->mailOptions],
+                [LogServiceInterface::class, $this->createMock(LogService::class)],
+                [SmtpTransport::class, new SmtpTransport()],
+                ['Invalid Listener Test', 'Invalid Listener provided'],
+            ]);
+        $this->container->expects($this->any())
+            ->method('has')
+            ->willReturnMap([
+                [InvalidArgumentException::class, true],
+                ['Invalid Listener Test', true],
+            ]);
+
+        $this->expectException(InvalidArgumentException::class);
+        (new Subject())($this->container, $requestedName);
+    }
 }

test/Options/SmtpOptionsTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DotTest\Mail\Options;
+
+use Dot\Mail\Options\SmtpOptions;
+use DotTest\Mail\CommonTrait;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Exception\InvalidArgumentException;
+
+class SmtpOptionsTest extends TestCase
+{
+    use CommonTrait;
+
+    public function testSmtpGettersAndSetters(): void
+    {
+        $subject = new SmtpOptions();
+
+        $subject->setName('smtpTest');
+        $subject->setConnectionTimeLimit(123);
+
+        $this->assertIsString($subject->getName());
+        $this->assertIsArray($subject->getConnectionConfig());
+        $this->assertIsString($subject->getHost());
+        $this->assertIsString($subject->getConnectionClass());
+        $this->assertIsInt($subject->getPort());
+        $this->assertIsInt($subject->getConnectionTimeLimit());
+
+        $this->expectException(InvalidArgumentException::class);
+        $subject->setPort(0);
+    }
+}

test/Service/MailServiceTest.php

@@ -120,7 +120,7 @@ public function testAttachFilesToMimeMessageBody(): void
 
         $mimeMessage = new TextPart($stringMessage);
         $this->mailService->setSubject('Test Subject');
-        $this->message->setBody($mimeMessage);
+        $this->mailService->setBody($mimeMessage);
         $this->mailService->addAttachments([
             $this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf',
             $this->fileSystem->url() . '/data/mail/attachments/testXlsAttachment.xls',