OXDEV-9927 Add notifiercollector tests

NikolaIvanovski · NikolaIvanovski · commit d076eca9d717 · 2025-12-04T11:57:05.000+02:00
diff --git a/src/Authentication/OAuth2/Service/ProviderCollector.php b/src/Authentication/OAuth2/Service/ProviderCollector.php
@@ -9,10 +9,8 @@
 
 namespace OxidEsales\SecurityModule\Authentication\OAuth2\Service;
 
-use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\ProviderNotActiveException;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Exception\ProviderNotFoundException;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Infrastructure\Provider\ProviderAdapterInterface;
-use OxidEsales\SecurityModule\Authentication\OAuth2\Service\Exception\ProviderNotActive;
 use Symfony\Component\Translation\Provider\ProviderInterface;
 
 class ProviderCollector implements ProviderCollectorInterface
diff --git a/src/Authentication/TwoFactorAuth/Exception/NotifierNotFoundException.php b/src/Authentication/TwoFactorAuth/Exception/NotifierNotFoundException.php
@@ -5,9 +5,10 @@
  * See LICENSE file for license details.
  */
 
-namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service;
+declare(strict_types=1);
 
-interface NotifierServiceInterface
-{
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
+class NotifierNotFoundException extends \Exception
+{
 }
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Provider/Email/EmailAdapter.php b/src/Authentication/TwoFactorAuth/Infrastructure/Provider/Email/EmailAdapter.php
@@ -7,23 +7,24 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider;
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Email;
 
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Factory\EmailFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\NotifierAdapterInterface;
 
-class EmailAdapter
+class EmailAdapter implements NotifierAdapterInterface
 {
     public function __construct(
         readonly private EmailFactoryInterface $emailFactory,
     ) {
     }
 
-    public function getName()
+    public function getName(): string
     {
         return 'email';
     }
 
-    public function notify($recipient, $code): void
+    public function notify(string $recipient, string $code): void
     {
         $emailModel = $this->emailFactory->create();
         $emailModel->sendEmail(
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Provider/NotifierAdapterInterface.php b/src/Authentication/TwoFactorAuth/Infrastructure/Provider/NotifierAdapterInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider;
+
+interface NotifierAdapterInterface
+{
+    public function getName(): string;
+
+    public function notify(string $recipient, string $code): void;
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Provider/services.yaml b/src/Authentication/TwoFactorAuth/Infrastructure/Provider/services.yaml
@@ -6,5 +6,5 @@ services:
     autowire: true
     public: false
 
-  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\EmailAdapter:
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Email\EmailAdapter:
     tags: [ 'security.twofa.tag.notify.provider' ]
diff --git a/src/Authentication/TwoFactorAuth/Service/NotifierCollector.php b/src/Authentication/TwoFactorAuth/Service/NotifierCollector.php
@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\NotifierNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\NotifierAdapterInterface;
+
+class NotifierCollector implements NotifierCollectorInterface
+{
+    private readonly array $collectedNotifiers;
+
+    /**
+     * @param iterable<NotifierAdapterInterface> $notifiers
+     */
+    public function __construct(
+        protected iterable $notifiers,
+    ) {
+        $this->collectedNotifiers = iterator_to_array($this->notifiers, false);
+    }
+
+    public function getNotifier(string $name): NotifierAdapterInterface
+    {
+        $notifierFound = array_filter(
+            $this->collectedNotifiers,
+            fn ($notifier) => $notifier->getName() === $name
+        );
+
+        if (!$notifierFound) {
+            throw new NotifierNotFoundException();
+        }
+
+        return reset($notifierFound);
+    }
+}
diff --git a/src/Authentication/TwoFactorAuth/Service/NotifierCollectorInterface.php b/src/Authentication/TwoFactorAuth/Service/NotifierCollectorInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\NotifierNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\NotifierAdapterInterface;
+
+interface NotifierCollectorInterface
+{
+    /**
+     * @throws NotifierNotFoundException
+     */
+    public function getNotifier(string $name): NotifierAdapterInterface;
+}
diff --git a/src/Authentication/TwoFactorAuth/Service/NotifierService.php b/src/Authentication/TwoFactorAuth/Service/NotifierService.php
diff --git a/src/Authentication/TwoFactorAuth/Service/services.yaml b/src/Authentication/TwoFactorAuth/Service/services.yaml
@@ -8,12 +8,14 @@ services:
 
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsService
+    public: true
 
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\AuthorizeServiceInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\AuthorizeService
+    public: true
 
-  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\NotifierServiceInterface:
-    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\NotifierService
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\NotifierCollectorInterface:
+    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\NotifierCollector
     public: true
     arguments:
       $notifiers: !tagged 'security.twofa.tag.notify.provider'
diff --git a/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserFactoryTest.php b/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserFactoryTest.php
@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Integration\Authentication\TwoFactorAuth\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserFactory;
+use PHPUnit\Framework\TestCase;
+
+class UserFactoryTest extends TestCase
+{
+    public function testCreateUserFactory(): void
+    {
+        $userFactory = new UserFactory();
+        $userModel = $userFactory->create();
+
+        $this->assertInstanceOf(User::class, $userModel);
+    }
+
+    public function testCreateMultipleUserFactory(): void
+    {
+        $userFactory = new UserFactory();
+
+        $userModel = $userFactory->create();
+        $this->assertInstanceOf(User::class, $userModel);
+
+        $newUserFactory = $userFactory->create();
+        $this->assertInstanceOf(User::class, $newUserFactory);
+        $this->assertNotSame($userModel, $newUserFactory);
+    }
+}
diff --git a/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Provider/Factory/EmailFactoryTest.php b/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Provider/Factory/EmailFactoryTest.php
@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Integration\Authentication\TwoFactorAuth\Infrastructure\Provider\Factory;
+
+use OxidEsales\Eshop\Core\Email;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Factory\EmailFactory;
+use PHPUnit\Framework\TestCase;
+
+class EmailFactoryTest extends TestCase
+{
+    public function testCreateUserFactory(): void
+    {
+        $emailFactory = new EmailFactory();
+        $emailModel = $emailFactory->create();
+
+        $this->assertInstanceOf(Email::class, $emailModel);
+    }
+
+    public function testCreateMultipleUserFactory(): void
+    {
+        $emailFactory = new EmailFactory();
+
+        $emailModel = $emailFactory->create();
+        $this->assertInstanceOf(Email::class, $emailModel);
+
+        $newEmailFactory = $emailFactory->create();
+        $this->assertInstanceOf(Email::class, $newEmailFactory);
+        $this->assertNotSame($emailModel, $newEmailFactory);
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/NotifierNotFoundExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/NotifierNotFoundExceptionTest.php
@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AttemptLimitExceededException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\NotifierNotFoundException;
+use PHPUnit\Framework\TestCase;
+
+class NotifierNotFoundExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $exception = new NotifierNotFoundException();
+
+        $this->assertInstanceOf(\Exception::class, $exception);
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Provider/Email/EmailAdapterTest.php b/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Provider/Email/EmailAdapterTest.php
@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Infrastructure\Provider\Email;
+
+use OxidEsales\Eshop\Core\Email;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Email\EmailAdapter;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Factory\EmailFactoryInterface;
+use PHPUnit\Framework\TestCase;
+
+class EmailAdapterTest extends TestCase
+{
+    public function testProviderName(): void
+    {
+        $sut = $this->getSut();
+
+        $this->assertSame('email', $sut->getName());
+    }
+
+    public function testEmailSend(): void
+    {
+        $recipient = uniqid();
+        $code = uniqid();
+
+        $emailModelMock = $this->createMock(Email::class);
+        $emailModelMock->expects($this->once())
+            ->method('sendEmail')
+            ->with(
+                $this->equalTo($recipient),
+                $this->equalTo('Your verification code'),
+                $this->equalTo("Your verification code is: {$code}")
+            );
+
+        $emailFactoryMock = $this->createMock(EmailFactoryInterface::class);
+        $emailFactoryMock->method('create')->willReturn($emailModelMock);
+
+        $sut = $this->getSut(
+            emailFactory: $emailFactoryMock
+        );
+
+        $sut->notify($recipient, $code);
+    }
+
+    private function getSut(
+        EmailFactoryInterface $emailFactory = null
+    ): EmailAdapter {
+        return new EmailAdapter(
+            emailFactory: $emailFactory ?? $this->createStub(EmailFactoryInterface::class)
+        );
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Service/NotifierCollectorTest.php b/tests/Unit/Authentication/TwoFactorAuth/Service/NotifierCollectorTest.php

Original file line number	Diff line number	Diff line change
`@@ -7,23 +7,24 @@`
`7`	`7`
`8`	`8`	`declare(strict_types=1);`
`9`	`9`
`10`		`-namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider;`
	`10`	`+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Email;`
`11`	`11`
`12`	`12`	`use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\Factory\EmailFactoryInterface;`
	`13`	`+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\NotifierAdapterInterface;`
`13`	`14`
`14`		`-class EmailAdapter`
	`15`	`+class EmailAdapter implements NotifierAdapterInterface`
`15`	`16`	`{`
`16`	`17`	`public function __construct(`
`17`	`18`	`readonly private EmailFactoryInterface $emailFactory,`
`18`	`19`	`) {`
`19`	`20`	`}`
`20`	`21`
`21`		`- public function getName()`
	`22`	`+ public function getName(): string`
`22`	`23`	`{`
`23`	`24`	`return 'email';`
`24`	`25`	`}`
`25`	`26`
`26`		`- public function notify($recipient, $code): void`
	`27`	`+ public function notify(string $recipient, string $code): void`
`27`	`28`	`{`
`28`	`29`	`$emailModel = $this->emailFactory->create();`
`29`	`30`	`$emailModel->sendEmail(`