refactor: add centralized reset method for AppConfigOverwrite in tests

vitormattos · vitormattos · commit c68d7212e8ef · 2025-12-15T18:41:40.000-03:00
- Add reset() method to AppConfigOverwrite that clears both overWrite and deleted arrays and returns self
- Add getMockAppConfigWithReset() wrapper in TestCase for convenient reset+return pattern
- Update all test classes to use getMockAppConfigWithReset() in setUp() methods
- Ensures clean state between tests without manual key-by-key deletion
- Improves test isolation and prevents state pollution across test suites

Signed-off-by: Vitor Mattos &lt;1079143+vitormattos@users.noreply.github.com&gt;
diff --git a/tests/php/Unit/Handler/CertificateEngine/AEngineHandlerTest.php b/tests/php/Unit/Handler/CertificateEngine/AEngineHandlerTest.php
@@ -10,6 +10,7 @@
 use OCA\Libresign\Handler\CertificateEngine\OpenSslHandler;
 use OCA\Libresign\Service\CaIdentifierService;
 use OCA\Libresign\Service\CertificatePolicyService;
+use OCA\Libresign\Tests\Unit\TestCase;
 use OCP\Files\AppData\IAppDataFactory;
 use OCP\IAppConfig;
 use OCP\IConfig;
@@ -32,18 +33,14 @@ final class AEngineHandlerTest extends \OCA\Libresign\Tests\Unit\TestCase {
 
 	public function setUp(): void {
 		$this->config = \OCP\Server::get(IConfig::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->appDataFactory = \OCP\Server::get(IAppDataFactory::class);
 		$this->dateTimeFormatter = \OCP\Server::get(IDateTimeFormatter::class);
 		$this->tempManager = \OCP\Server::get(ITempManager::class);
 		$this->certificatePolicyService = \OCP\Server::get(CertificatePolicyService::class);
 		$this->urlGenerator = \OCP\Server::get(IURLGenerator::class);
 		$this->caIdentifierService = \OCP\Server::get(CaIdentifierService::class);
 		$this->logger = \OCP\Server::get(LoggerInterface::class);
-
-		$this->appConfig->deleteKey(Application::APP_ID, 'certificate_engine');
-		$this->appConfig->deleteKey(Application::APP_ID, 'identify_methods');
-		$this->appConfig->deleteKey(Application::APP_ID, 'config_path');
 	}
 
 	private function getInstance(): OpenSslHandler {
diff --git a/tests/php/Unit/Handler/CertificateEngine/CertificateEngineFactoryTest.php b/tests/php/Unit/Handler/CertificateEngine/CertificateEngineFactoryTest.php
@@ -28,7 +28,7 @@ public function tearDown(): void {
 	}
 
 	public function setUp(): void {
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->openSslHandler = $this->createMock(OpenSslHandler::class);
 		$this->cfsslHandler = $this->createMock(CfsslHandler::class);
 		$this->noneHandler = $this->createMock(NoneHandler::class);
diff --git a/tests/php/Unit/Handler/CertificateEngine/OpenSslHandlerTest.php b/tests/php/Unit/Handler/CertificateEngine/OpenSslHandlerTest.php
@@ -14,6 +14,7 @@
 use OCA\Libresign\Service\CaIdentifierService;
 use OCA\Libresign\Service\CertificatePolicyService;
 use OCA\Libresign\Service\SerialNumberService;
+use OCA\Libresign\Tests\Unit\TestCase;
 use OCP\Files\AppData\IAppDataFactory;
 use OCP\IAppConfig;
 use OCP\IConfig;
@@ -39,7 +40,7 @@ final class OpenSslHandlerTest extends \OCA\Libresign\Tests\Unit\TestCase {
 	private string $tempDir;
 	public function setUp(): void {
 		$this->config = \OCP\Server::get(IConfig::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->appDataFactory = \OCP\Server::get(IAppDataFactory::class);
 		$this->dateTimeFormatter = \OCP\Server::get(IDateTimeFormatter::class);
 		$this->tempManager = \OCP\Server::get(ITempManager::class);
diff --git a/tests/php/Unit/Handler/FooterHandlerTest.php b/tests/php/Unit/Handler/FooterHandlerTest.php
@@ -27,7 +27,7 @@ final class FooterHandlerTest extends \OCA\Libresign\Tests\Unit\TestCase {
 	private ITempManager $tempManager;
 	private FooterHandler $footerHandler;
 	public function setUp(): void {
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->pdfParserService = $this->createMock(PdfParserService::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
 		$this->tempManager = \OCP\Server::get(ITempManager::class);
diff --git a/tests/php/Unit/Handler/PdfTest.php b/tests/php/Unit/Handler/PdfTest.php
@@ -24,7 +24,7 @@ final class PdfTest extends \OCA\Libresign\Tests\Unit\TestCase {
 	public function setUp(): void {
 		parent::setUp();
 		$this->javaHelper = $this->createMock(JavaHelper::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);
 	}
 
diff --git a/tests/php/Unit/Handler/SignEngine/JSignPdfHandlerTest.php b/tests/php/Unit/Handler/SignEngine/JSignPdfHandlerTest.php
@@ -13,6 +13,7 @@
 use OCA\Libresign\Db\FileElement;
 use OCA\Libresign\Handler\CertificateEngine\CertificateEngineFactory;
 use OCA\Libresign\Handler\SignEngine\JSignPdfHandler;
+use OCA\Libresign\Tests\Unit\TestCase;
 use OCA\Libresign\Helper\JavaHelper;
 use OCA\Libresign\Service\SignatureBackgroundService;
 use OCA\Libresign\Service\SignatureTextService;
@@ -63,7 +64,7 @@ public static function setUpBeforeClass(): void {
 		}
 	}
 	public function setUp(): void {
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->loggerInterface = $this->createMock(LoggerInterface::class);
 		$this->tempManager = \OCP\Server::get(ITempManager::class);
 		$this->signatureBackgroundService = $this->createMock(SignatureBackgroundService::class);
diff --git a/tests/php/Unit/Handler/SignEngine/Pkcs12HandlerTest.php b/tests/php/Unit/Handler/SignEngine/Pkcs12HandlerTest.php
@@ -37,7 +37,7 @@ final class Pkcs12HandlerTest extends \OCA\Libresign\Tests\Unit\TestCase {
 
 	public function setUp(): void {
 		$this->folderService = $this->createMock(FolderService::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->certificateEngineFactory = $this->createMock(CertificateEngineFactory::class);
 		$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);
 		$this->footerHandler = $this->createMock(FooterHandler::class);
diff --git a/tests/php/Unit/Helper/JavaHelperTest.php b/tests/php/Unit/Helper/JavaHelperTest.php
@@ -23,7 +23,7 @@ class JavaHelperTest extends \OCA\Libresign\Tests\Unit\TestCase {
 	public function setUp(): void {
 		parent::setUp();
 
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->l10n = $this->createMock(IL10N::class);
 		$this->logger = $this->createMock(LoggerInterface::class);
 	}
diff --git a/tests/php/Unit/Service/CertificatePolicyServiceTest.php b/tests/php/Unit/Service/CertificatePolicyServiceTest.php
@@ -33,7 +33,7 @@ final class CertificatePolicyServiceTest extends \OCA\Libresign\Tests\Unit\TestC
 	public function setUp(): void {
 		$this->appData = $this->createMock(IAppData::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);
 	}
 
diff --git a/tests/php/Unit/Service/FileServiceTest.php b/tests/php/Unit/Service/FileServiceTest.php
@@ -106,7 +106,7 @@ private function getService(): FileService {
 		$this->accountManager = $this->createMock(IAccountManager::class);
 		$this->client = \OCP\Server::get(IClientService::class);
 		$this->dateTimeFormatter = \OCP\Server::get(IDateTimeFormatter::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->urlGenerator = \OCP\Server::get(IURLGenerator::class);
 		$this->mimeTypeDetector = \OCP\Server::get(IMimeTypeDetector::class);
 		$this->pkcs12Handler = \OCP\Server::get(Pkcs12Handler::class);
diff --git a/tests/php/Unit/Service/FooterServiceTest.php b/tests/php/Unit/Service/FooterServiceTest.php
@@ -23,7 +23,7 @@ class FooterServiceTest extends TestCase {
 
 	public function setUp(): void {
 		parent::setUp();
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->footerHandler = $this->createMock(FooterHandler::class);
 		$this->service = new FooterService($this->appConfig, $this->footerHandler);
 	}
diff --git a/tests/php/Unit/Service/IdentifyMethod/PasswordTest.php b/tests/php/Unit/Service/IdentifyMethod/PasswordTest.php
@@ -43,7 +43,7 @@ final class PasswordTest extends \OCA\Libresign\Tests\Unit\TestCase {
 
 	public function setUp(): void {
 		$this->identifyService = $this->createMock(IdentifyService::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->folderService = $this->createMock(FolderService::class);
 		$this->certificateEngineFactory = $this->createMock(CertificateEngineFactory::class);
 		$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);
diff --git a/tests/php/Unit/Service/Install/ConfigureCheckServiceTest.php b/tests/php/Unit/Service/Install/ConfigureCheckServiceTest.php
@@ -48,7 +48,7 @@ final class ConfigureCheckServiceTest extends \OCA\Libresign\Tests\Unit\TestCase
 
 	public function setUp(): void {
 		self::$mockExtensionLoaded = [];
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->systemConfig = $this->createMock(SystemConfig::class);
 		$this->ocAppConfig = $this->createMock(AppConfig::class);
 		$this->appManager = $this->createMock(IAppManager::class);
diff --git a/tests/php/Unit/Service/Install/SignSetupServiceTest.php b/tests/php/Unit/Service/Install/SignSetupServiceTest.php
@@ -35,7 +35,7 @@ public function setUp(): void {
 		$this->fileAccessHelper = new FileAccessHelper();
 		$this->appManager = $this->createMock(IAppManager::class);
 		$this->config = $this->createMock(IConfig::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->appDataFactory = \OCP\Server::get(IAppDataFactory::class);
 		$this->tempManager = \OCP\Server::get(ITempManager::class);
 	}
diff --git a/tests/php/Unit/Service/ReminderServiceTest.php b/tests/php/Unit/Service/ReminderServiceTest.php
@@ -31,7 +31,7 @@ final class ReminderServiceTest extends \OCA\Libresign\Tests\Unit\TestCase {
 
 	public function setUp(): void {
 		$this->jobList = $this->createMock(IJobList::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->dateTimeZone = Server::get(IDateTimeZone::class);
 		$this->time = $this->createMock(ITimeFactory::class);
 		$this->signRequestMapper = $this->createMock(SignRequestMapper::class);
diff --git a/tests/php/Unit/Service/SignFileServiceTest.php b/tests/php/Unit/Service/SignFileServiceTest.php
@@ -105,7 +105,7 @@ public function setUp(): void {
 		$this->userManager = $this->createMock(IUserManager::class);
 		$this->folderService = $this->createMock(FolderService::class);
 		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->validateHelper = $this->createMock(\OCA\Libresign\Helper\ValidateHelper::class);
 		$this->signerElementsService = $this->createMock(SignerElementsService::class);
 		$this->root = $this->createMock(\OCP\Files\IRootFolder::class);
diff --git a/tests/php/Unit/Service/SignatureBackgroundServiceTest.php b/tests/php/Unit/Service/SignatureBackgroundServiceTest.php
@@ -23,7 +23,7 @@ final class SignatureBackgroundServiceTest extends \OCA\Libresign\Tests\Unit\Tes
 
 	public function setUp(): void {
 		$this->appData = $this->createMock(IAppData::class);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->config = $this->createMock(IConfig::class);
 		$this->tempManager = $this->createMock(ITempManager::class);
 	}
diff --git a/tests/php/Unit/Service/SignatureTextServiceTest.php b/tests/php/Unit/Service/SignatureTextServiceTest.php
@@ -30,7 +30,7 @@ final class SignatureTextServiceTest extends \OCA\Libresign\Tests\Unit\TestCase
 
 	public function setUp(): void {
 		$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);
-		$this->appConfig = $this->getMockAppConfig();
+		$this->appConfig = $this->getMockAppConfigWithReset();
 		$this->dateTimeZone = \OCP\Server::get(IDateTimeZone::class);
 		$this->request = $this->createMock(IRequest::class);
 		$this->userSession = $this->createMock(IUserSession::class);
diff --git a/tests/php/Unit/TestCase.php b/tests/php/Unit/TestCase.php
@@ -82,6 +82,14 @@ public static function getMockAppConfig(): IAppConfig {
 		return $service;
 	}
 
+	public static function getMockAppConfigWithReset(): IAppConfig {
+		$appConfig = self::getMockAppConfig();
+		if ($appConfig instanceof AppConfigOverwrite) {
+			$appConfig->reset();
+		}
+		return $appConfig;
+	}
+
 	public function mockConfig($config):void {
 		$service = \OCP\Server::get(\OCP\IConfig::class);
 		if (!$service instanceof AllConfigOverwrite) {
diff --git a/tests/php/lib/AppConfigOverwrite.php b/tests/php/lib/AppConfigOverwrite.php
@@ -138,6 +138,12 @@ public function deleteKey(string $app, string $key): void {
 		$this->markDeleted($app, $key);
 	}
 
+	public function reset(): self {
+		$this->overWrite = [];
+		$this->deleted = [];
+		return $this;
+	}
+
 	private function isDeleted(string $app, string $key): bool {
 		return isset($this->deleted[$app][$key]);
 	}

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function tearDown(): void {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public function setUp(): void {`
`31`		`- $this->appConfig = $this->getMockAppConfig();`
	`31`	`+ $this->appConfig = $this->getMockAppConfigWithReset();`
`32`	`32`	`$this->openSslHandler = $this->createMock(OpenSslHandler::class);`
`33`	`33`	`$this->cfsslHandler = $this->createMock(CfsslHandler::class);`
`34`	`34`	`$this->noneHandler = $this->createMock(NoneHandler::class);`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ final class PdfTest extends \OCA\Libresign\Tests\Unit\TestCase {`
`24`	`24`	`public function setUp(): void {`
`25`	`25`	`parent::setUp();`
`26`	`26`	`$this->javaHelper = $this->createMock(JavaHelper::class);`
`27`		`- $this->appConfig = $this->getMockAppConfig();`
	`27`	`+ $this->appConfig = $this->getMockAppConfigWithReset();`
`28`	`28`	`$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);`
`29`	`29`	`}`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class JavaHelperTest extends \OCA\Libresign\Tests\Unit\TestCase {`
`23`	`23`	`public function setUp(): void {`
`24`	`24`	`parent::setUp();`
`25`	`25`
`26`		`- $this->appConfig = $this->getMockAppConfig();`
	`26`	`+ $this->appConfig = $this->getMockAppConfigWithReset();`
`27`	`27`	`$this->l10n = $this->createMock(IL10N::class);`
`28`	`28`	`$this->logger = $this->createMock(LoggerInterface::class);`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ final class CertificatePolicyServiceTest extends \OCA\Libresign\Tests\Unit\TestC`
`33`	`33`	`public function setUp(): void {`
`34`	`34`	`$this->appData = $this->createMock(IAppData::class);`
`35`	`35`	`$this->urlGenerator = $this->createMock(IURLGenerator::class);`
`36`		`- $this->appConfig = $this->getMockAppConfig();`
	`36`	`+ $this->appConfig = $this->getMockAppConfigWithReset();`
`37`	`37`	`$this->l10n = \OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID);`
`38`	`38`	`}`
`39`	`39`