@centreon/js-config 24.4.10 → 24.4.12

package/cypress/e2e/commands.ts

@@ -1,11 +1,6 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 
 import './commands/configuration';
-import './commands/monitoring';
-
-import installLogsCollector from 'cypress-terminal-report/src/installLogsCollector';
-
-installLogsCollector({ enableExtendedCollector: true });
 
 const apiLoginV2 = '/centreon/authentication/providers/configurations/local';
 
@@ -28,7 +23,7 @@ Cypress.Commands.add('getWebVersion', (): Cypress.Chainable => {
 
 Cypress.Commands.add('getIframeBody', (): Cypress.Chainable => {
   return cy
-    .get('iframe#main-content', { timeout: 10000 })
+    .get('iframe#main-content')
     .its('0.contentDocument.body')
     .should('not.be.empty')
     .then(cy.wrap);
@@ -44,13 +39,6 @@ Cypress.Commands.add(
   }
 );
 
-Cypress.Commands.add(
-  'clickSubRootMenuItem',
-  (page: string): Cypress.Chainable => {
-    return cy.get('div[data-cy="collapse"]').eq(1).contains(page).click();
-  }
-);
-
 interface NavigateToProps {
   page: string;
   rootItemNumber: number;
@@ -63,13 +51,8 @@ Cypress.Commands.add(
     if (subMenu) {
       cy.hoverRootMenuItem(rootItemNumber)
         .contains(subMenu)
-        .trigger('mouseover')
-        .get('.MuiCollapse-wrapper')
-        .find('div[data-cy="collapse"]')
-        .should('be.visible')
-        .and('contain', page);
-
-      cy.clickSubRootMenuItem(page);
+        .trigger('mouseover', { force: true });
+      cy.contains(page).click({ force: true });
 
       return;
     }
@@ -102,41 +85,29 @@ Cypress.Commands.add(
 
 interface CopyFromContainerProps {
   destination: string;
-  name?: string;
   source: string;
 }
 
 Cypress.Commands.add(
   'copyFromContainer',
-  (
-    {
-      name = Cypress.env('dockerName'),
-      source,
-      destination
-    }: CopyFromContainerProps,
-    options?: Partial<Cypress.ExecOptions>
-  ) => {
-    return cy.exec(`docker cp ${name}:${source} "${destination}"`, options);
+  ({ source, destination }: CopyFromContainerProps) => {
+    return cy.exec(
+      `docker cp ${Cypress.env('dockerName')}:${source} "${destination}"`
+    );
   }
 );
 
 interface CopyToContainerProps {
   destination: string;
-  name?: string;
   source: string;
 }
 
 Cypress.Commands.add(
   'copyToContainer',
-  (
-    {
-      name = Cypress.env('dockerName'),
-      source,
-      destination
-    }: CopyToContainerProps,
-    options?: Partial<Cypress.ExecOptions>
-  ) => {
-    return cy.exec(`docker cp ${source} ${name}:${destination}`, options);
+  ({ source, destination }: CopyToContainerProps) => {
+    return cy.exec(
+      `docker cp ${source} ${Cypress.env('dockerName')}:${destination}`
+    );
   }
 );
 
@@ -147,7 +118,7 @@ interface LoginByTypeOfUserProps {
 
 Cypress.Commands.add(
   'loginByTypeOfUser',
-  ({ jsonName = 'admin', loginViaApi = false }): Cypress.Chainable => {
+  ({ jsonName, loginViaApi }): Cypress.Chainable => {
     if (loginViaApi) {
       return cy
         .fixture(`users/${jsonName}.json`)
@@ -164,25 +135,24 @@ Cypress.Commands.add(
         .visit(`${Cypress.config().baseUrl}`)
         .wait('@getNavigationList');
     }
-
     cy.visit(`${Cypress.config().baseUrl}`)
       .fixture(`users/${jsonName}.json`)
       .then((credential) => {
-        cy.getByLabel({ label: 'Alias', tag: 'input' }).type(
-          `{selectAll}{backspace}${credential.login}`
-        );
+        cy.getByLabel({ label: 'Alias', tag: 'input' }).type(credential.login);
         cy.getByLabel({ label: 'Password', tag: 'input' }).type(
-          `{selectAll}{backspace}${credential.password}`
+          credential.password
         );
       })
       .getByLabel({ label: 'Connect', tag: 'button' })
       .click();
 
-    return cy.get('.MuiAlert-message').then(($snackbar) => {
-      if ($snackbar.text().includes('Login succeeded')) {
-        cy.wait('@getNavigationList');
-      }
-    });
+    return cy
+      .get('.SnackbarContent-root > .MuiPaper-root')
+      .then(($snackbar) => {
+        if ($snackbar.text().includes('Login succeeded')) {
+          cy.wait('@getNavigationList');
+        }
+      });
   }
 );
 
@@ -240,20 +210,29 @@ interface StartContainerProps {
 Cypress.Commands.add(
   'startContainer',
   ({ name, image, portBindings }: StartContainerProps): Cypress.Chainable => {
-    cy.log(`Starting container ${name} from image ${image}`);
+    return cy
+      .exec('docker image list --format "{{.Repository}}:{{.Tag}}"')
+      .then(({ stdout }) => {
+        if (
+          stdout.match(
+            new RegExp(
+              `^${image.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')}`,
+              'm'
+            )
+          )
+        ) {
+          cy.log(`Local docker image found : ${image}`);
 
-    return cy.task(
-      'startContainer',
-      { image, name, portBindings },
-      { timeout: 600000 } // 10 minutes because docker pull can be very slow
-    );
-  }
-);
+          return cy.wrap(image);
+        }
 
-Cypress.Commands.add(
-  'createDirectory',
-  (directoryPath: string): Cypress.Chainable => {
-    return cy.task('createDirectory', directoryPath);
+        cy.log(`Pulling remote docker image : ${image}`);
+
+        return cy.exec(`docker pull ${image}`).then(() => cy.wrap(image));
+      })
+      .then((imageName) =>
+        cy.task('startContainer', { image: imageName, name, portBindings })
+      );
   }
 );
 
@@ -268,7 +247,7 @@ Cypress.Commands.add(
   'startWebContainer',
   ({
     name = Cypress.env('dockerName'),
-    os = Cypress.env('WEB_IMAGE_OS'),
+    os = 'alma9',
     useSlim = true,
     version = Cypress.env('WEB_IMAGE_VERSION')
   }: StartWebContainerProps = {}): Cypress.Chainable => {
@@ -283,13 +262,12 @@ Cypress.Commands.add(
         portBindings: [{ destination: 4000, source: 80 }]
       })
       .then(() => {
-        const baseUrl = 'http://127.0.0.1:4000';
+        const baseUrl = 'http://0.0.0.0:4000';
 
         Cypress.config('baseUrl', baseUrl);
 
-        return cy.task(
-          'waitOn',
-          `${baseUrl}/centreon/api/latest/platform/installation/status`
+        return cy.exec(
+          `npx wait-on ${baseUrl}/centreon/api/latest/platform/installation/status`
         );
       })
       .visit('/') // this is necessary to refresh browser cause baseUrl has changed (flash appears in video)
@@ -306,7 +284,7 @@ Cypress.Commands.add(
   ({
     name = Cypress.env('dockerName')
   }: StopWebContainerProps = {}): Cypress.Chainable => {
-    const logDirectory = `results/logs/${Cypress.spec.name.replace(
+    const logDirectory = `cypress/results/logs/${Cypress.spec.name.replace(
       artifactIllegalCharactersMatcher,
       '_'
     )}/${Cypress.currentTest.title.replace(
@@ -316,64 +294,25 @@ Cypress.Commands.add(
 
     return cy
       .visitEmptyPage()
-      .createDirectory(logDirectory)
+      .exec(`mkdir -p "${logDirectory}"`)
       .copyFromContainer({
         destination: `${logDirectory}/broker`,
-        name,
         source: '/var/log/centreon-broker'
       })
       .copyFromContainer({
         destination: `${logDirectory}/engine`,
-        name,
         source: '/var/log/centreon-engine'
       })
+      .execInContainer({
+        command: `bash -e <<EOF
+        chmod 777 /var/log/centreon/centreon-web.log > /dev/null 2>&1 || :
+EOF`,
+        name
+      })
       .copyFromContainer({
         destination: `${logDirectory}/centreon`,
-        name,
         source: '/var/log/centreon'
       })
-      .copyFromContainer({
-        destination: `${logDirectory}/centreon-gorgone`,
-        name,
-        source: '/var/log/centreon-gorgone'
-      })
-      .then(() => {
-        if (Cypress.env('WEB_IMAGE_OS').includes('alma')) {
-          return cy.copyFromContainer({
-            destination: `${logDirectory}/php`,
-            name,
-            source: '/var/log/php-fpm'
-          });
-        }
-
-        return cy.copyFromContainer(
-          {
-            destination: `${logDirectory}/php8.1-fpm-centreon-error.log`,
-            name,
-            source: '/var/log/php8.1-fpm-centreon-error.log'
-          },
-          { failOnNonZeroExit: false }
-        );
-      })
-      .then(() => {
-        if (Cypress.env('WEB_IMAGE_OS').includes('alma')) {
-          return cy.copyFromContainer({
-            destination: `${logDirectory}/httpd`,
-            name,
-            source: '/var/log/httpd'
-          });
-        }
-
-        return cy.copyFromContainer(
-          {
-            destination: `${logDirectory}/apache2`,
-            name,
-            source: '/var/log/apache2'
-          },
-          { failOnNonZeroExit: false }
-        );
-      })
-      .exec(`chmod -R 755 "${logDirectory}"`)
       .stopContainer({ name });
   }
 );
@@ -385,11 +324,9 @@ interface StopContainerProps {
 Cypress.Commands.add(
   'stopContainer',
   ({ name }: StopContainerProps): Cypress.Chainable => {
-    cy.log(`Stopping container ${name}`);
-
     cy.exec(`docker logs ${name}`).then(({ stdout }) => {
       cy.writeFile(
-        `results/logs/${Cypress.spec.name.replace(
+        `cypress/results/logs/${Cypress.spec.name.replace(
           artifactIllegalCharactersMatcher,
           '_'
         )}/${Cypress.currentTest.title.replace(
@@ -404,192 +341,21 @@ Cypress.Commands.add(
   }
 );
 
-interface Dashboard {
-  description?: string;
-  name: string;
-}
-
-Cypress.Commands.add(
-  'insertDashboardList',
-  (fixtureFile: string): Cypress.Chainable => {
-    return cy.fixture(fixtureFile).then((dashboardList) => {
-      cy.wrap(
-        Promise.all(
-          dashboardList.map((dashboardBody: Dashboard) =>
-            cy.insertDashboard({ ...dashboardBody })
-          )
-        )
-      );
-    });
-  }
-);
-
-Cypress.Commands.add(
-  'insertDashboard',
-  (dashboardBody: Dashboard): Cypress.Chainable => {
-    return cy.request({
-      body: {
-        ...dashboardBody
-      },
-      method: 'POST',
-      url: '/centreon/api/latest/configuration/dashboards'
-    });
-  }
-);
-
-Cypress.Commands.add(
-  'insertDashboardWithWidget',
-  (dashboardBody, patchBody) => {
-    cy.request({
-      body: {
-        ...dashboardBody
-      },
-      method: 'POST',
-      url: '/centreon/api/latest/configuration/dashboards'
-    }).then((response) => {
-      const dashboardId = response.body.id;
-      cy.waitUntil(
-        () => {
-          return cy
-            .request({
-              method: 'GET',
-              url: `/centreon/api/latest/configuration/dashboards/${dashboardId}`
-            })
-            .then((getResponse) => {
-              return getResponse.body && getResponse.body.id === dashboardId;
-            });
-        },
-        {
-          timeout: 10000
-        }
-      );
-      cy.request({
-        body: patchBody,
-        method: 'PATCH',
-        url: `/centreon/api/latest/configuration/dashboards/${dashboardId}`
-      });
-    });
-  }
-);
-
-interface ShareDashboardToUserProps {
-  dashboardName: string;
-  role: string;
-  userName: string;
-}
-
-interface ListingRequestResult {
-  body: {
-    result: Array<{
-      id: number;
-    }>;
-  };
-}
-
-interface PatchDashboardBody {
-  panels: Array<{
-    layout: {
-      height: number;
-      min_height: number;
-      min_width: number;
-      width: number;
-      x: number;
-      y: number;
-    };
-    name: string;
-    widget_settings: {
-      options: {
-        description: {
-          content: string;
-          enabled: boolean;
-        };
-        name: string;
-      };
-    };
-    widget_type: string;
-  }>;
-}
-
-Cypress.Commands.add(
-  'shareDashboardToUser',
-  ({ dashboardName, userName, role }: ShareDashboardToUserProps): void => {
-    Promise.all([
-      cy.request({
-        method: 'GET',
-        url: `/centreon/api/latest/configuration/users?search={"name":"${userName}"}`
-      }),
-      cy.request({
-        method: 'GET',
-        url: `/centreon/api/latest/configuration/dashboards?search={"name":"${dashboardName}"}`
-      })
-    ]).then(
-      ([retrievedUser, retrievedDashboard]: [
-        ListingRequestResult,
-        ListingRequestResult
-      ]) => {
-        const userId = retrievedUser.body.result[0].id;
-        const dashboardId = retrievedDashboard.body.result[0].id;
-
-        cy.request({
-          body: {
-            id: userId,
-            role: `${role}`
-          },
-          method: 'POST',
-          url: `/centreon/api/latest/configuration/dashboards/${dashboardId}/access_rights/contacts`
-        });
-      }
-    );
-  }
-);
-
-Cypress.Commands.add('getTimeFromHeader', (): Cypress.Chainable => {
-  return cy
-    .get('header div[data-cy="clock"]', { timeout: 10000 })
-    .should('be.visible')
-    .then(($time) => {
-      const headerTime = $time.children()[1].textContent;
-      if (headerTime?.match(/\d+:\d+/)) {
-        cy.log(`header time is : ${headerTime}`);
-
-        return cy.wrap(headerTime);
-      }
-
-      throw new Error(`header time is not displayed`);
-    });
-});
-
 declare global {
   namespace Cypress {
     interface Chainable {
-      clickSubRootMenuItem: (page: string) => Cypress.Chainable;
-      copyFromContainer: (
-        props: CopyFromContainerProps,
-        options?: Partial<Cypress.ExecOptions>
-      ) => Cypress.Chainable;
-      copyToContainer: (
-        props: CopyToContainerProps,
-        options?: Partial<Cypress.ExecOptions>
-      ) => Cypress.Chainable;
-      createDirectory: (directoryPath: string) => Cypress.Chainable;
+      copyFromContainer: (props: CopyFromContainerProps) => Cypress.Chainable;
+      copyToContainer: (props: CopyToContainerProps) => Cypress.Chainable;
       execInContainer: ({
         command,
         name
       }: ExecInContainerProps) => Cypress.Chainable;
       getIframeBody: () => Cypress.Chainable;
-      getTimeFromHeader: () => Cypress.Chainable;
       getWebVersion: () => Cypress.Chainable;
       hoverRootMenuItem: (rootItemNumber: number) => Cypress.Chainable;
-      insertDashboard: (dashboard: Dashboard) => Cypress.Chainable;
-      insertDashboardList: (fixtureFile: string) => Cypress.Chainable;
-      insertDashboardWithWidget: (
-        dashboard: Dashboard,
-        patch: PatchDashboardBody
-      ) => Cypress.Chainable;
-
       loginByTypeOfUser: ({
-        jsonName,
-        loginViaApi
+        jsonName = 'admin',
+        loginViaApi = false
       }: LoginByTypeOfUserProps) => Cypress.Chainable;
       moveSortableElement: (direction: string) => Cypress.Chainable;
       navigateTo: ({
@@ -597,11 +363,6 @@ declare global {
         rootItemNumber,
         subMenu
       }: NavigateToProps) => Cypress.Chainable;
-      shareDashboardToUser: ({
-        dashboardName,
-        userName,
-        role
-      }: ShareDashboardToUserProps) => Cypress.Chainable;
       startContainer: ({
         name,
         image

package/cypress/e2e/configuration.ts

@@ -4,18 +4,13 @@
 import { execSync } from 'child_process';
 
 import { defineConfig } from 'cypress';
-import installLogsPrinter from 'cypress-terminal-report/src/installLogsPrinter';
-import { config as configDotenv } from 'dotenv';
 
-import esbuildPreprocessor from './esbuild-preprocessor';
-import plugins from './plugins';
-import tasks from './tasks';
+import setupNodeEvents from './plugins';
 
 interface ConfigurationOptions {
   cypressFolder?: string;
   dockerName?: string;
   env?: Record<string, unknown>;
-  envFile?: string;
   isDevelopment?: boolean;
   specPattern: string;
 }
@@ -25,14 +20,11 @@ export default ({
   cypressFolder,
   isDevelopment,
   dockerName,
-  env,
-  envFile
+  env
 }: ConfigurationOptions): Cypress.ConfigOptions => {
-  if (envFile) {
-    configDotenv({ path: envFile });
-  }
-
-  const resultsFolder = `${cypressFolder || '.'}/results`;
+  const resultsFolder = `${cypressFolder || 'cypress'}/results${
+    isDevelopment ? '/dev' : ''
+  }`;
 
   const webImageVersion = execSync('git rev-parse --abbrev-ref HEAD')
     .toString('utf8')
@@ -43,34 +35,44 @@ export default ({
     defaultCommandTimeout: 6000,
     e2e: {
       excludeSpecPattern: ['*.js', '*.ts', '*.md'],
-      fixturesFolder: 'fixtures',
-      reporter: require.resolve('cypress-multi-reporters'),
-      reporterOptions: {
-        configFile: `${__dirname}/reporter-config.js`
-      },
-      setupNodeEvents: async (on, config) => {
-        installLogsPrinter(on);
-        await esbuildPreprocessor(on, config);
-        tasks(on);
-
-        return plugins(on, config);
-      },
-      specPattern,
-      supportFile: 'support/e2e.{js,jsx,ts,tsx}'
+      setupNodeEvents,
+      specPattern
     },
     env: {
       ...env,
-      OPENID_IMAGE_VERSION: process.env.MAJOR || '24.04',
+      OPENID_IMAGE_VERSION: '23.04',
       WEB_IMAGE_OS: 'alma9',
       WEB_IMAGE_VERSION: webImageVersion,
       dockerName: dockerName || 'centreon-dev'
     },
-    execTimeout: 60000,
+    execTimeout: 120000,
+    reporter: 'mochawesome',
+    reporterOptions: {
+      html: false,
+      json: true,
+      overwrite: true,
+      reportDir: `${resultsFolder}/reports`,
+      reportFilename: '[name]-report.json'
+    },
     requestTimeout: 10000,
     retries: 0,
     screenshotsFolder: `${resultsFolder}/screenshots`,
+    setupNodeEvents: (on, config) => {
+      on('before:browser:launch', (browser, launchOptions) => {
+        if (browser.name === 'chrome' && browser.isHeadless) {
+          launchOptions.args = launchOptions.args.map((arg) => {
+            if (arg === '--headless') {
+              return '--headless=new';
+            }
+
+            return arg;
+          });
+        }
+
+        return launchOptions;
+      });
+    },
     video: true,
-    videoCompression: 0,
     videosFolder: `${resultsFolder}/videos`
   });
 };