Merge pull request PrestaShop#35974 from Progi1984/test8934

Functional Tests : API : PUT /modules/toggle-status

tests/UI/campaigns/functional/API/02_endpoints/09_modules/03_putModulesToggleStatus.ts

@@ -0,0 +1,213 @@
+// Import utils
+import api from '@utils/api';
+import basicHelper from '@utils/basicHelper';
+import helper from '@utils/helpers';
+import testContext from '@utils/testContext';
+
+// Import commonTests
+import {deleteAPIClientTest} from '@commonTests/BO/advancedParameters/authServer';
+import loginCommon from '@commonTests/BO/loginBO';
+
+// Import pages
+import apiClientPage from 'pages/BO/advancedParameters/APIClient';
+import addNewApiClientPage from '@pages/BO/advancedParameters/APIClient/add';
+import dashboardPage from '@pages/BO/dashboard';
+import {moduleManager as moduleManagerPage, moduleManager} from '@pages/BO/modules/moduleManager';
+
+// Import data
+import APIClientData from '@data/faker/APIClient';
+import {ModuleInfo} from '@data/types/module';
+
+import {
+  boModuleManagerPage,
+} from '@prestashop-core/ui-testing';
+
+import {expect} from 'chai';
+import type {APIRequestContext, BrowserContext, Page} from 'playwright';
+
+const baseContext: string = 'functional_API_endpoints_modules_putModulesToggleStatus';
+
+describe('API : PUT /modules/toggle-status', async () => {
+  let apiContext: APIRequestContext;
+  let browserContext: BrowserContext;
+  let page: Page;
+  let clientSecret: string;
+  let accessToken: string;
+  let moduleInfo1: ModuleInfo;
+  let moduleInfo2: ModuleInfo;
+
+  const clientScope: string = 'module_write';
+  const clientData: APIClientData = new APIClientData({
+    enabled: true,
+    scopes: [
+      clientScope,
+    ],
+  });
+
+  before(async function () {
+    browserContext = await helper.createBrowserContext(this.browser);
+    page = await helper.newTab(browserContext);
+
+    apiContext = await helper.createAPIContext(global.API.URL);
+  });
+
+  after(async () => {
+    await helper.closeBrowserContext(browserContext);
+  });
+
+  describe('BackOffice : Fetch the access token', async () => {
+    it('should login in BO', async function () {
+      await loginCommon.loginBO(this, page);
+    });
+
+    it('should go to \'Advanced Parameters > API Client\' page', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'goToAdminAPIPage', baseContext);
+
+      await dashboardPage.goToSubMenu(
+        page,
+        dashboardPage.advancedParametersLink,
+        dashboardPage.adminAPILink,
+      );
+
+      const pageTitle = await apiClientPage.getPageTitle(page);
+      expect(pageTitle).to.eq(apiClientPage.pageTitle);
+    });
+
+    it('should check that no records found', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'checkThatNoRecordFound', baseContext);
+
+      const noRecordsFoundText = await apiClientPage.getTextForEmptyTable(page);
+      expect(noRecordsFoundText).to.contains('warning No records found');
+    });
+
+    it('should go to add New API Client page', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'goToNewAPIClientPage', baseContext);
+
+      await apiClientPage.goToNewAPIClientPage(page);
+
+      const pageTitle = await addNewApiClientPage.getPageTitle(page);
+      expect(pageTitle).to.eq(addNewApiClientPage.pageTitleCreate);
+    });
+
+    it('should create API Client', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'createAPIClient', baseContext);
+
+      const textResult = await addNewApiClientPage.addAPIClient(page, clientData);
+      expect(textResult).to.contains(addNewApiClientPage.successfulCreationMessage);
+
+      const textMessage = await addNewApiClientPage.getAlertInfoBlockParagraphContent(page);
+      expect(textMessage).to.contains(addNewApiClientPage.apiClientGeneratedMessage);
+    });
+
+    it('should copy client secret', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'copyClientSecret', baseContext);
+
+      await addNewApiClientPage.copyClientSecret(page);
+
+      clientSecret = await addNewApiClientPage.getClipboardText(page);
+      expect(clientSecret.length).to.be.gt(0);
+    });
+
+    it('should request the endpoint /access_token', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'requestOauth2Token', baseContext);
+
+      const apiResponse = await apiContext.post('access_token', {
+        form: {
+          client_id: clientData.clientId,
+          client_secret: clientSecret,
+          grant_type: 'client_credentials',
+          scope: clientScope,
+        },
+      });
+      expect(apiResponse.status()).to.eq(200);
+      expect(api.hasResponseHeader(apiResponse, 'Content-Type')).to.eq(true);
+      expect(api.getResponseHeader(apiResponse, 'Content-Type')).to.contains('application/json');
+
+      const jsonResponse = await apiResponse.json();
+      expect(jsonResponse).to.have.property('access_token');
+      expect(jsonResponse.token_type).to.be.a('string');
+
+      accessToken = jsonResponse.access_token;
+    });
+  });
+
+  describe('BackOffice : Fetch two modules', async () => {
+    it('should go to \'Modules > Module Manager\' page', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'goToModulesPage', baseContext);
+
+      await dashboardPage.goToSubMenu(page, dashboardPage.modulesParentLink, dashboardPage.modulesParentLink);
+      await boModuleManagerPage.closeSfToolBar(page);
+      await moduleManager.filterByStatus(page, 'installed');
+
+      const pageTitle = await boModuleManagerPage.getPageTitle(page);
+      expect(pageTitle).to.contains(boModuleManagerPage.pageTitle);
+    });
+
+    it('should fetch modules', async function () {
+      await testContext.addContextItem(this, 'testIdentifier', 'fetchModules', baseContext);
+
+      moduleInfo1 = await moduleManager.getModuleInformationNth(page, 1);
+      moduleInfo2 = await moduleManager.getModuleInformationNth(page, 2);
+    });
+  });
+
+  [
+    {
+      status: false,
+      verb: 'disable',
+    },
+    {
+      status: true,
+      verb: 'enable',
+    },
+  ].forEach((arg: {status: boolean, verb: string}, index: number) => {
+    describe(`API : Update modules (${basicHelper.capitalize(arg.verb)})`, async () => {
+      it('should request the endpoint /modules/toggle-status', async function () {
+        await testContext.addContextItem(this, 'testIdentifier', `requestEndpoint${index}`, baseContext);
+
+        const apiResponse = await apiContext.put('modules/toggle-status', {
+          headers: {
+            Authorization: `Bearer ${accessToken}`,
+          },
+          data: {
+            modules: [
+              moduleInfo1.technicalName,
+              moduleInfo2.technicalName,
+            ],
+            enabled: arg.status,
+          },
+        });
+
+        expect(apiResponse.status()).to.eq(204);
+
+        const response = (await apiResponse.body()).toString();
+        expect(response).to.be.equal('');
+      });
+    });
+
+    describe(`BackOffice : Check modules are ${arg.verb}d`, async () => {
+      it('should filter list by technical name', async function () {
+        await testContext.addContextItem(this, 'testIdentifier', `checkModules${index}`, baseContext);
+
+        await dashboardPage.goToSubMenu(page, dashboardPage.modulesParentLink, dashboardPage.modulesParentLink);
+        await boModuleManagerPage.closeSfToolBar(page);
+
+        const pageTitle = await boModuleManagerPage.getPageTitle(page);
+        expect(pageTitle).to.contains(boModuleManagerPage.pageTitle);
+
+        const modules: ModuleInfo[] = [
+          moduleInfo1,
+          moduleInfo2,
+        ];
+
+        for (let idxModule = 0; idxModule < modules.length; idxModule++) {
+          const isModuleEnabled = await moduleManagerPage.isModuleStatus(page, modules[idxModule].technicalName, 'enable');
+          expect(isModuleEnabled).to.eq(arg.status);
+        }
+      });
+    });
+  });
+
+  // Pre-condition: Create an API Client
+  deleteAPIClientTest(`${baseContext}_postTest`);
+});