OXDEV-8489 Prepared & Consumed ModuleBlocklistService

Prepared this service ModuleBlocklistService
Consumed above service in ModuleSwitchService

module_blocklist.yaml

@@ -0,0 +1,3 @@
+modules:
+  - oe_graphql_base
+  - oe_graphql_configuration_access

src/Module/Exception/ModuleBlockListException.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\GraphQL\ConfigurationAccess\Module\Exception;
+
+use OxidEsales\GraphQL\Base\Exception\NotFound;
+
+final class ModuleBlockListException extends NotFound
+{
+    public const EXCEPTION_MESSAGE = "Failed to load module blocklist from YAML file.";
+
+    public function __construct()
+    {
+        parent::__construct(self::EXCEPTION_MESSAGE);
+    }
+}

src/Module/Exception/ModuleDeactivationException.php

@@ -13,7 +13,7 @@
 
 final class ModuleDeactivationException extends NotFound
 {
-    public const EXCEPTION_MESSAGE = "An error occurred while deactivating the module.";
+    public const EXCEPTION_MESSAGE = "This Module is in the blocklist and cannot be deactivated.";
 
     public function __construct()
     {

src/Module/Service/ModuleBlocklistService.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\GraphQL\ConfigurationAccess\Module\Service;
+
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleBlockListException;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\YamlFileLoaderInfrastructureInterface;
+
+class ModuleBlocklistService implements ModuleBlocklistServiceInterface
+{
+    public function __construct(
+        private readonly string $moduleBlocklist,
+        private readonly YamlFileLoaderInfrastructureInterface $yamlFileLoader
+    ) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isModuleBlocked(string $moduleId): bool
+    {
+        try {
+            $resolvedPath = dirname(__FILE__) . '/' . $this->moduleBlocklist;
+            $blocklistData = $this->yamlFileLoader->load($resolvedPath);
+
+            return in_array($moduleId, $blocklistData['modules'], true);
+        } catch (\Exception $e) {
+            throw new ModuleBlockListException();
+        }
+    }
+}

src/Module/Service/ModuleBlocklistServiceInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+namespace OxidEsales\GraphQL\ConfigurationAccess\Module\Service;
+
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleBlockListException;
+
+interface ModuleBlocklistServiceInterface
+{
+    /**
+     * @throws ModuleBlockListException
+     */
+    public function isModuleBlocked(string $moduleId): bool;
+}

src/Module/Service/ModuleSwitchService.php

@@ -9,22 +9,33 @@
 
 namespace OxidEsales\GraphQL\ConfigurationAccess\Module\Service;
 
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleDeactivationException;
 use OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\ModuleSwitchInfrastructureInterface;
 
 class ModuleSwitchService implements ModuleSwitchServiceInterface
 {
     public function __construct(
-        private readonly ModuleSwitchInfrastructureInterface $moduleSwitchInfrastructure
+        private readonly ModuleSwitchInfrastructureInterface $moduleSwitchInfrastructure,
+        private readonly ModuleBlocklistServiceInterface $moduleBlocklistService
     ) {
     }
 
+    /**
+     * @inheritDoc
+     */
     public function activateModule(string $moduleId): bool
     {
         return $this->moduleSwitchInfrastructure->activateModule(moduleId: $moduleId);
     }
 
+    /**
+     * @inheritDoc
+     */
     public function deactivateModule(string $moduleId): bool
     {
+        if ($this->moduleBlocklistService->isModuleBlocked($moduleId)) {
+            throw new ModuleDeactivationException();
+        }
         return $this->moduleSwitchInfrastructure->deactivateModule(moduleId: $moduleId);
     }
 }

src/Module/Service/ModuleSwitchServiceInterface.php

@@ -7,8 +7,15 @@
 
 namespace OxidEsales\GraphQL\ConfigurationAccess\Module\Service;
 
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleActivationException;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleDeactivationException;
+
 interface ModuleSwitchServiceInterface
 {
     public function activateModule(string $moduleId): bool;
+
+    /**
+     * @throws ModuleDeactivationException
+     */
     public function deactivateModule(string $moduleId): bool;
 }

src/Module/services.yaml

@@ -1,3 +1,6 @@
+parameters:
+  oxidesales.graphqlconfigurationaccess.modules_block_list: '../../../module_blocklist.yaml'
+
 services:
   _defaults:
     public: false
@@ -15,3 +18,11 @@ services:
 
   OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleSwitchServiceInterface:
     class: OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleSwitchService
+
+  OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\YamlFileLoaderInfrastructureInterface:
+    class: OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\YamlFileLoaderInfrastructure
+
+  OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleBlocklistServiceInterface:
+    class: OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleBlocklistService
+    arguments:
+      $moduleBlocklist: '%oxidesales.graphqlconfigurationaccess.modules_block_list%'

tests/Unit/Module/Exception/ModuleBlockListExceptionTest.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\ConfigurationAccess\Tests\Unit\Module\Exception;
+
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleBlockListException;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleBlockListException
+ */
+final class ModuleBlockListExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $exception = new ModuleBlockListException();
+
+        $this->assertInstanceOf(ModuleBlockListException::class, $exception);
+        $this->assertSame(ModuleBlockListException::EXCEPTION_MESSAGE, $exception->getMessage());
+    }
+}

tests/Unit/Module/Infrastructure/ModuleSwitchInfrastructureTest.php

@@ -85,9 +85,10 @@ public static function activationDataProvider(): \Generator
 
     public static function exceptionDataProvider(): \Generator
     {
+        $moduleId = uniqid();
         yield 'test activate module throws exception' => [
             'method' => 'activate',
-            'moduleId' => uniqid(),
+            'moduleId' => $moduleId,
             'exceptionClass' => ModuleActivationException::class,
 
         ];

tests/Unit/Module/Service/ModuleBlocklistServiceTest.php

@@ -0,0 +1,82 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\ConfigurationAccess\Tests\Unit\Module\Service;
+
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleBlockListException;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\YamlFileLoaderInfrastructureInterface;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleBlocklistService;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleBlocklistService
+ */
+class ModuleBlocklistServiceTest extends TestCase
+{
+    /**
+     * @dataProvider blockListDataProvider
+     */
+    public function testIsModuleBlocked(
+        string $moduleId,
+        bool $expectedResult
+    ): void {
+        $filePath = 'testFilePath.yaml';
+        $expectedData = ['modules' => ['module1', 'module2']];
+
+        $yamlFileLoaderMock = $this->createMock(YamlFileLoaderInfrastructureInterface::class);
+        $yamlFileLoaderMock
+            ->method('load')
+            ->with($this->stringContains($filePath))
+            ->willReturn($expectedData);
+
+        $sut = $this->getSut(moduleBlockList: $filePath, yamlFileLoader: $yamlFileLoaderMock);
+        $actualResult = $sut->isModuleBlocked(moduleId: $moduleId);
+
+        $this->assertSame($expectedResult, $actualResult);
+    }
+
+    public static function blockListDataProvider(): \Generator
+    {
+        yield 'isModuleBlocked returns true if Module is in the BlockList' => [
+            'moduleId' => 'module1',
+            'expectedResult' => true
+        ];
+
+        yield 'isModuleBlocked returns false if Module is not in the BlockList' => [
+            'moduleId' => 'unknownModuleId',
+            'expectedResult' => false
+        ];
+    }
+
+    public function testGetModuleBlocklistThrowsExceptionOnFailure(): void
+    {
+        $moduleId = uniqid();
+        $yamlFileLoaderMock = $this->createMock(YamlFileLoaderInfrastructureInterface::class);
+        $yamlFileLoaderMock
+            ->method('load')
+            ->will($this->throwException(new \Exception('Failed to load YAML file')));
+
+        $this->expectException(ModuleBlockListException::class);
+
+        $sut = $this->getSut(yamlFileLoader: $yamlFileLoaderMock);
+        $sut->isModuleBlocked(moduleId: $moduleId);
+    }
+
+    private function getSut(
+        string $moduleBlockList = null,
+        YamlFileLoaderInfrastructureInterface $yamlFileLoader = null
+    ): ModuleBlocklistService {
+        return new ModuleBlocklistService(
+            moduleBlocklist: $moduleBlockList
+            ?? 'testFilePath.yaml',
+            yamlFileLoader: $yamlFileLoader
+            ?? $this->createStub(YamlFileLoaderInfrastructureInterface::class)
+        );
+    }
+}

tests/Unit/Module/Service/ModuleSwitchServiceTest.php

@@ -10,6 +10,7 @@
 namespace OxidEsales\GraphQL\ConfigurationAccess\Tests\Unit\Module\Service;
 
 use OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure\ModuleSwitchInfrastructureInterface;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleBlocklistServiceInterface;
 use OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleSwitchService;
 use PHPUnit\Framework\TestCase;
 
@@ -31,7 +32,16 @@ public function testModuleActivationAndDeactivation(
             ->with($moduleId)
             ->willReturn(true);
 
-        $sut = $this->getSut(moduleSwitchInfrastructure: $moduleSwitchInfrastructureMock);
+        $moduleBlocklistServiceMock = $this->createMock(ModuleBlocklistServiceInterface::class);
+        $moduleBlocklistServiceMock
+            ->method('isModuleBlocked')
+            ->with($moduleId)
+            ->willReturn(false);
+
+        $sut = $this->getSut(
+            moduleSwitchInfrastructure: $moduleSwitchInfrastructureMock,
+            moduleBlocklistService: $moduleBlocklistServiceMock
+        );
         $actualResult = ($method == 'activateModule')
             ? $sut->activateModule(moduleId: $moduleId)
             : $sut->deactivateModule(moduleId: $moduleId);
@@ -40,11 +50,14 @@ public function testModuleActivationAndDeactivation(
     }
 
     private function getSut(
-        ModuleSwitchInfrastructureInterface $moduleSwitchInfrastructure = null
+        ModuleSwitchInfrastructureInterface $moduleSwitchInfrastructure = null,
+        ModuleBlocklistServiceInterface $moduleBlocklistService = null
     ): ModuleSwitchService {
         return new ModuleSwitchService(
             moduleSwitchInfrastructure: $moduleSwitchInfrastructure
-                ?? $this->createStub(ModuleSwitchInfrastructureInterface::class)
+                ?? $this->createStub(ModuleSwitchInfrastructureInterface::class),
+            moduleBlocklistService: $moduleBlocklistService
+                ?? $this->createStub(ModuleBlocklistServiceInterface::class)
         );
     }