OXDEV-9078 Adjust exceptions tree

Sieg · Sieg · commit 96427d7bb4c7 · 2026-04-06T15:01:08.000+03:00
More clear structure and naming. The base TwoFAException to clearly see where issue is coming from.
diff --git a/src/Authentication/TwoFactorAuth/Exception/AttemptLimitExceededException.php b/src/Authentication/TwoFactorAuth/Exception/AttemptLimitExceededException.php
@@ -9,7 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class AttemptLimitExceededException extends OTPValidationException
+class AttemptLimitExceededException extends CodeValidationException
 {
     public function __construct()
     {
diff --git a/src/Authentication/TwoFactorAuth/Exception/AuthenticationTypeNotFoundException.php b/src/Authentication/TwoFactorAuth/Exception/AuthenticationTypeNotFoundException.php
@@ -9,6 +9,6 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class AuthenticationTypeNotFoundException extends \Exception
+class AuthenticationTypeNotFoundException extends TwoFAException
 {
 }
diff --git a/src/Authentication/TwoFactorAuth/Exception/CodeValidationException.php b/src/Authentication/TwoFactorAuth/Exception/CodeValidationException.php
@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
+
+class CodeValidationException extends TwoFAException
+{
+}
diff --git a/src/Authentication/TwoFactorAuth/Exception/InvalidCodeException.php b/src/Authentication/TwoFactorAuth/Exception/InvalidCodeException.php
@@ -9,7 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class InvalidCodeException extends OTPValidationException
+class InvalidCodeException extends CodeValidationException
 {
     public function __construct()
     {
diff --git a/src/Authentication/TwoFactorAuth/Exception/MalformedRequestException.php b/src/Authentication/TwoFactorAuth/Exception/MalformedRequestException.php
@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
+
+class MalformedRequestException extends TwoFAException
+{
+    public function __construct()
+    {
+        parent::__construct('ERROR_MALFORMED_REQUEST');
+    }
+}
diff --git a/src/Authentication/TwoFactorAuth/Exception/NotifierNotFoundException.php b/src/Authentication/TwoFactorAuth/Exception/NotifierNotFoundException.php
@@ -9,6 +9,6 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class NotifierNotFoundException extends \Exception
+class NotifierNotFoundException extends TwoFAException
 {
 }
diff --git a/src/Authentication/TwoFactorAuth/Exception/TimeExpiredException.php b/src/Authentication/TwoFactorAuth/Exception/TimeExpiredException.php
@@ -9,7 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class TimeExpiredException extends OTPValidationException
+class TimeExpiredException extends CodeValidationException
 {
     public function __construct()
     {
diff --git a/src/Authentication/TwoFactorAuth/Exception/TwoFAException.php b/src/Authentication/TwoFactorAuth/Exception/TwoFAException.php
@@ -11,6 +11,6 @@
 
 use OxidEsales\Eshop\Core\Exception\StandardException;
 
-class OTPValidationException extends StandardException
+class TwoFAException extends StandardException
 {
 }
diff --git a/src/Authentication/TwoFactorAuth/Exception/UserNotFoundException.php b/src/Authentication/TwoFactorAuth/Exception/UserNotFoundException.php
@@ -9,6 +9,6 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class UserNotFoundException extends \Exception
+class UserNotFoundException extends TwoFAException
 {
 }
diff --git a/src/Authentication/TwoFactorAuth/Exception/VerificatorNotFoundException.php b/src/Authentication/TwoFactorAuth/Exception/VerificatorNotFoundException.php
@@ -9,7 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
 
-class VerificatorNotFoundException extends \Exception
+class VerificatorNotFoundException extends TwoFAException
 {
     public function __construct()
     {
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/AttemptLimitExceededExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/AttemptLimitExceededExceptionTest.php
@@ -10,6 +10,7 @@
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
 
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AttemptLimitExceededException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\CodeValidationException;
 use PHPUnit\Framework\TestCase;
 
 class AttemptLimitExceededExceptionTest extends TestCase
@@ -18,6 +19,7 @@ public function testException(): void
     {
         $exception = new AttemptLimitExceededException();
 
+        $this->assertInstanceOf(CodeValidationException::class, $exception);
         $this->assertSame('ERROR_ATTEMPT_LIMIT_EXCEEDED', $exception->getMessage());
     }
 }
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/AuthenticationTypeNotFoundExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/AuthenticationTypeNotFoundExceptionTest.php
@@ -0,0 +1,22 @@
+<?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\AuthenticationTypeNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\TwoFAException;
+use PHPUnit\Framework\TestCase;
+
+class AuthenticationTypeNotFoundExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $this->assertInstanceOf(TwoFAException::class, new AuthenticationTypeNotFoundException());
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/InvalidCodeExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/InvalidCodeExceptionTest.php
@@ -9,6 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
 
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\CodeValidationException;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\InvalidCodeException;
 use PHPUnit\Framework\TestCase;
 
@@ -18,6 +19,7 @@ public function testException(): void
     {
         $exception = new InvalidCodeException();
 
+        $this->assertInstanceOf(CodeValidationException::class, $exception);
         $this->assertSame('ERROR_INVALID_CODE', $exception->getMessage());
     }
 }
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/MalformedRequestExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/MalformedRequestExceptionTest.php
@@ -0,0 +1,25 @@
+<?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\MalformedRequestException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\TwoFAException;
+use PHPUnit\Framework\TestCase;
+
+class MalformedRequestExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $exception = new MalformedRequestException();
+
+        $this->assertInstanceOf(TwoFAException::class, $exception);
+        $this->assertSame('ERROR_MALFORMED_REQUEST', $exception->getMessage());
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/NotifierNotFoundExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/NotifierNotFoundExceptionTest.php
@@ -9,16 +9,14 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
 
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AttemptLimitExceededException;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\NotifierNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\TwoFAException;
 use PHPUnit\Framework\TestCase;
 
 class NotifierNotFoundExceptionTest extends TestCase
 {
     public function testException(): void
     {
-        $exception = new NotifierNotFoundException();
-
-        $this->assertInstanceOf(\Exception::class, $exception);
+        $this->assertInstanceOf(TwoFAException::class, new NotifierNotFoundException());
     }
 }
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/TimeExpiredExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/TimeExpiredExceptionTest.php
@@ -9,6 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
 
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\CodeValidationException;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\TimeExpiredException;
 use PHPUnit\Framework\TestCase;
 
@@ -18,6 +19,7 @@ public function testException(): void
     {
         $exception = new TimeExpiredException();
 
+        $this->assertInstanceOf(CodeValidationException::class, $exception);
         $this->assertSame('ERROR_CODE_TIME_EXPIRED', $exception->getMessage());
     }
 }
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/UserNotFoundExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/UserNotFoundExceptionTest.php
@@ -0,0 +1,22 @@
+<?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\TwoFAException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\UserNotFoundException;
+use PHPUnit\Framework\TestCase;
+
+class UserNotFoundExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $this->assertInstanceOf(TwoFAException::class, new UserNotFoundException());
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Exception/VerificatorNotFoundExceptionTest.php b/tests/Unit/Authentication/TwoFactorAuth/Exception/VerificatorNotFoundExceptionTest.php
@@ -9,6 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Exception;
 
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\TwoFAException;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\VerificatorNotFoundException;
 use PHPUnit\Framework\TestCase;
 
@@ -18,6 +19,7 @@ public function testException(): void
     {
         $exception = new VerificatorNotFoundException();
 
+        $this->assertInstanceOf(TwoFAException::class, $exception);
         $this->assertSame('ERROR_VERIFICATOR_NOT_FOUND', $exception->getMessage());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;`
`11`	`11`
`12`		`-class AttemptLimitExceededException extends OTPValidationException`
	`12`	`+class AttemptLimitExceededException extends CodeValidationException`
`13`	`13`	`{`
`14`	`14`	`public function __construct()`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@`
`9`	`9`
`10`	`10`	`namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;`
`11`	`11`
`12`		`-class AuthenticationTypeNotFoundException extends \Exception`
	`12`	`+class AuthenticationTypeNotFoundException extends TwoFAException`
`13`	`13`	`{`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@`
`11`	`11`
`12`	`12`	`use OxidEsales\Eshop\Core\Exception\StandardException;`
`13`	`13`
`14`		`-class OTPValidationException extends StandardException`
	`14`	`+class TwoFAException extends StandardException`
`15`	`15`	`{`
`16`	`16`	`}`