Merge branch 'b-7.2.x-change-module-status-OXDEV-8216' into b-7.2.x

OXID-eSales · Aug 13, 2024 · 76c4e6a · 76c4e6a
2 parents fd841fe + 423f2d3
commit 76c4e6a
Show file tree

Hide file tree

Showing 17 changed files with 505 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Theme list and filtering option on basis of theme name and status
 - Module list and filtering option on basis of module name and status
 - Activation of given theme by themeId
+- Mutations to activate and deactive a module.
 
 ## [1.1.0] - 2024-07-05
 This is stable release for v1.1.0. No changes have been made since v1.1.0-rc.1.

diff --git a/src/Module/Controller/ModuleActivationController.php b/src/Module/Controller/ModuleActivationController.php
@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\ConfigurationAccess\Module\Controller;
+
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleActivationServiceInterface;
+use TheCodingMachine\GraphQLite\Annotations\Logged;
+use TheCodingMachine\GraphQLite\Annotations\Mutation;
+use TheCodingMachine\GraphQLite\Annotations\Right;
+
+class ModuleActivationController
+{
+    public function __construct(
+        private readonly ModuleActivationServiceInterface $moduleActivationService
+    ) {
+    }
+
+    /**
+     * Mutation of Configuration Access Module
+     * @param string $moduleId
+     * @return bool
+     */
+    #[Mutation]
+    #[Logged]
+    #[Right('ACTIVATE_MODULE')]
+    public function activateModule(string $moduleId): bool
+    {
+        return $this->moduleActivationService->activateModule(moduleId: $moduleId);
+    }
+
+    /**
+     * Mutation of Configuration Access Module
+     * @param string $moduleId
+     * @return bool
+     */
+    #[Mutation]
+    #[Logged]
+    #[Right('ACTIVATE_MODULE')]
+    public function deactivateModule(string $moduleId): bool
+    {
+        return $this->moduleActivationService->deactivateModule(moduleId: $moduleId);
+    }
+}
diff --git a/src/Module/Exception/ModuleActivationException.php b/src/Module/Exception/ModuleActivationException.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 ModuleActivationException extends NotFound
+{
+    private const EXCEPTION_MESSAGE = "An error occurred while activating the module.";
+
+    public function __construct()
+    {
+        parent::__construct(self::EXCEPTION_MESSAGE);
+    }
+}
diff --git a/src/Module/Exception/ModuleDeactivationException.php b/src/Module/Exception/ModuleDeactivationException.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 ModuleDeactivationException extends NotFound
+{
+    private const EXCEPTION_MESSAGE = "An error occurred while deactivating the module.";
+
+    public function __construct()
+    {
+        parent::__construct(self::EXCEPTION_MESSAGE);
+    }
+}
diff --git a/src/Module/Infrastructure/ModuleListInfrastructure.php b/src/Module/Infrastructure/ModuleListInfrastructure.php
@@ -9,7 +9,6 @@
 
 namespace OxidEsales\GraphQL\ConfigurationAccess\Module\Infrastructure;
 
-use OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\DataObject\ModuleConfiguration;
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\Bridge\ShopConfigurationDaoBridgeInterface;
 use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModulesNotFoundException;
 

diff --git a/src/Module/Service/ModuleActivationService.php b/src/Module/Service/ModuleActivationService.php
@@ -0,0 +1,56 @@
+<?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\EshopCommunity\Internal\Framework\Module\Setup\Bridge\ModuleActivationBridgeInterface;
+use OxidEsales\EshopCommunity\Internal\Transition\Utility\ContextInterface;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleActivationException;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleDeactivationException;
+
+class ModuleActivationService implements ModuleActivationServiceInterface
+{
+    public function __construct(
+        private readonly ContextInterface $context,
+        private readonly ModuleActivationBridgeInterface $moduleActivationBridge
+    ) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function activateModule(string $moduleId): bool
+    {
+        $shopId = $this->context->getCurrentShopId();
+
+        try {
+            $this->moduleActivationBridge->activate(moduleId: $moduleId, shopId: $shopId);
+        } catch (\Exception $exception) {
+            throw new ModuleActivationException();
+        }
+
+        return true;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function deactivateModule(string $moduleId): bool
+    {
+        $shopId = $this->context->getCurrentShopId();
+
+        try {
+            $this->moduleActivationBridge->deactivate(moduleId: $moduleId, shopId: $shopId);
+        } catch (\Exception $exception) {
+            throw new ModuleDeactivationException();
+        }
+
+        return true;
+    }
+}
diff --git a/src/Module/Service/ModuleActivationServiceInterface.php b/src/Module/Service/ModuleActivationServiceInterface.php
@@ -0,0 +1,24 @@
+<?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\ModuleActivationException;
+use OxidEsales\GraphQL\ConfigurationAccess\Module\Exception\ModuleDeactivationException;
+
+interface ModuleActivationServiceInterface
+{
+    /**
+     * @throws ModuleActivationException
+     */
+    public function activateModule(string $moduleId): bool;
+
+    /**
+     * @throws ModuleDeactivationException
+     */
+    public function deactivateModule(string $moduleId): bool;
+}
diff --git a/src/Module/services.yaml b/src/Module/services.yaml
@@ -18,3 +18,6 @@ services:
 
   OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleListServiceInterface:
     class: OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleListService
+
+  OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleActivationServiceInterface:
+    class: OxidEsales\GraphQL\ConfigurationAccess\Module\Service\ModuleActivationService
diff --git a/src/Shared/Service/PermissionProvider.php b/src/Shared/Service/PermissionProvider.php
@@ -19,7 +19,8 @@ public function getPermissions(): array
             'oxidadmin' => [
                 'CHANGE_CONFIGURATION',
                 'LIST_THEMES',
-                'LIST_MODULES'
+                'LIST_MODULES',
+                'ACTIVATE_MODULE'
             ],
         ];
     }

diff --git a/tests/Codeception/Acceptance/Module/ModuleActivationCest.php b/tests/Codeception/Acceptance/Module/ModuleActivationCest.php
@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\ConfigurationAccess\Tests\Codeception\Acceptance\Module;
+
+use Codeception\Attribute\DataProvider;
+use OxidEsales\GraphQL\ConfigurationAccess\Tests\Codeception\Acceptance\BaseCest;
+use OxidEsales\GraphQL\ConfigurationAccess\Tests\Codeception\AcceptanceTester;
+
+/**
+ * @group module_activation
+ * @group theme_switch
+ * @group setting_access
+ * @group oe_graphql_configuration_access
+ */
+final class ModuleActivationCest extends BaseCest
+{
+    #[DataProvider('moduleDeActivationDataProvider')]
+    public function testModuleActivationAuthorized(AcceptanceTester $I, \Codeception\Example $example): void
+    {
+        $I->login($this->getAdminUsername(), $this->getAdminPassword());
+
+        $result = $this->runModuleMutation(
+            I: $I,
+            queryName: $example['queryName'],
+            field: $example['field']
+        );
+
+        $I->assertNotSame('You do not have sufficient rights to access this field', $result['errors'][0]['message']);
+    }
+
+    private function runModuleMutation(
+        AcceptanceTester $I,
+        string $queryName,
+        string $field
+    ): array {
+        $I->login($this->getAdminUsername(), $this->getAdminPassword());
+        $I->sendGQLQuery(
+            'mutation {
+			  		' . $queryName . '(' . $field . ': "' . self::TEST_MODULE_ID . '")
+				}'
+        );
+
+        $I->seeResponseIsJson();
+        return $I->grabJsonResponseAsArray();
+    }
+
+    protected function moduleDeActivationDataProvider(): \Generator
+    {
+        yield ['queryName' => 'activateModule', 'field' => 'moduleId'];
+        yield ['queryName' => 'deactivateModule', 'field' => 'moduleId'];
+    }
+}
diff --git a/tests/Codeception/Acceptance/NotAuthorizedAccessCest.php b/tests/Codeception/Acceptance/NotAuthorizedAccessCest.php
@@ -15,6 +15,7 @@
 /**
  * @group theme_switch
  * @group theme_list
+ * @group module_activation
  * @group theme_setting
  * @group setting_access
  * @group oe_graphql_configuration_access
@@ -36,7 +37,7 @@ public function testGetSettingNotAuthorizedQuery(AcceptanceTester $I, \Codecepti
             isList: false
         );
 
-        $this->assertQueryFoundErrorInResult($I, $result);
+        $this->assertQueryNotFoundErrorInResult($I, $result);
     }
 
     #[DataProvider('listQueriesDataProvider')]
@@ -52,7 +53,7 @@ public function testGetSettingNotAuthorizedQueryList(AcceptanceTester $I, \Codec
             isList: true
         );
 
-        $this->assertQueryFoundErrorInResult($I, $result);
+        $this->assertQueryNotFoundErrorInResult($I, $result);
     }
 
     #[DataProvider('themeMutationsDataProvider')]
@@ -70,21 +71,54 @@ public function testGetSettingNotAuthorizedMutation(AcceptanceTester $I, \Codece
             location: $example['location']
         );
 
-        $this->assertQueryFoundErrorInResult($I, $result);
+        $this->assertQueryNotFoundErrorInResult($I, $result);
     }
 
-
-    public function testSwitchThemeNotAuthorizedMutation(AcceptanceTester $I): void
+    #[DataProvider('mutationsReturnsBoolDataProvider')]
+    public function testMutationsReturnsBoolNotAuthorized(AcceptanceTester $I, \Codeception\Example $example): void
     {
         $I->login($this->getAgentUsername(), $this->getAgentPassword());
+        $result = $this->runSimplifiedAccessCheckMutationForBool(
+            I: $I,
+            queryName: $example['queryName'],
+            field: $example['field'],
+            value: $example['value']
+        );
+
+        $this->assertQueryNotFoundErrorInResult($I, $result);
+    }
+
+    private function runSimplifiedAccessCheckMutationForBool(
+        AcceptanceTester $I,
+        string $queryName,
+        string $field,
+        mixed $value,
+    ): array {
+        $parameters = $field . ': "' . $value . '"';
         $I->sendGQLQuery(
             'mutation {
-                switchTheme(identifier : "test")
+                ' . $queryName . '(' . $parameters . ')
             }'
         );
 
         $I->seeResponseIsJson();
-        $this->assertQueryFoundErrorInResult($I, $I->grabJsonResponseAsArray());
+
+        return $I->grabJsonResponseAsArray();
+    }
+
+    protected function mutationsReturnsBoolDataProvider(): \Generator
+    {
+        yield [
+            'queryName' => 'activateModule',
+            'field' => 'moduleId',
+            'value' => 'test'
+        ];
+
+        yield [
+            'queryName' => 'deactivateModule',
+            'field' => 'moduleId',
+            'value' => 'test'
+        ];
     }
 
     protected function themeGettersDataProvider(): \Generator
@@ -139,8 +173,6 @@ protected function listQueriesDataProvider(): \Generator
         yield ['queryName' => 'themeSettings', 'field' => 'name', 'location' => 'theme'];
         yield ['queryName' => 'moduleSettings', 'field' => 'name', 'location' => 'module'];
         yield ['queryName' => 'shopSettings', 'field' => 'name', 'location' => 'shop'];
-        yield ['queryName' => 'themesList', 'field' => 'title', 'location' => ''];
-        yield ['queryName' => 'modules', 'field' => 'title', 'location' => ''];
     }
 
     protected function moduleGettersDataProvider(): \Generator
@@ -264,16 +296,16 @@ private function runSimplifiedAccessCheckMutation(
         return $I->grabJsonResponseAsArray();
     }
 
-    private function getLocationParameterString(string $location): string
+    private function getLocationParameterString(string $location): ?string
     {
         return match ($location) {
             'module' => 'moduleId: "testModule"',
             'theme' => 'themeId: "testTheme"',
-            default => ''
+            default => null
         };
     }
 
-    protected function assertQueryFoundErrorInResult(AcceptanceTester $I, array $result): void
+    protected function assertQueryNotFoundErrorInResult(AcceptanceTester $I, array $result): void
     {
         $errorMessage = $result['errors'][0]['message'];
         $I->assertSame(