@centreon/js-config 24.4.29 → 24.4.31

package/cypress/component/commands.tsx

@@ -18,6 +18,15 @@ interface MountProps {
   Component: React.ReactNode;
   options?: object;
 }
+interface Resolution {
+  height: number;
+  width: number;
+}
+
+interface MakeSnapshotWithCustomResolution {
+  resolution: Resolution;
+  title: string;
+}
 
 export enum Method {
   DELETE = 'DELETE',
@@ -97,20 +106,32 @@ Cypress.Commands.add(
   }
 );
 
-Cypress.Commands.add('moveSortableElement', ({ element, direction }): void => {
-  const key = `{${direction}arrow}`;
+interface MoveSortableElementProps {
+  direction: 'up' | 'down' | 'left' | 'right';
+  element: Cypress.Chainable<JQuery<HTMLElement>>;
+  times?: number;
+}
 
-  element.type(' ', {
-    force: true,
-    scrollBehavior: false
-  });
-  element.eq(-1).type(key, {
-    scrollBehavior: false
-  });
-  element.eq(-1).type(' ', {
-    scrollBehavior: false
-  });
-});
+Cypress.Commands.add(
+  'moveSortableElement',
+  ({ element, direction, times = 1 }: MoveSortableElementProps): void => {
+    const key = `{${direction}arrow}`;
+
+    element.type(' ', {
+      force: true,
+      scrollBehavior: false
+    });
+
+    Array.from({ length: times }).forEach(() => {
+      element.eq(-1).type(key, {
+        scrollBehavior: false
+      });
+    });
+    element.eq(-1).type(' ', {
+      scrollBehavior: false
+    });
+  }
+);
 
 Cypress.Commands.add(
   'moveSortableElementUsingAriaLabel',
@@ -137,6 +158,15 @@ Cypress.Commands.add('makeSnapshot', (title?: string) => {
   cy.matchImageSnapshot(title);
 });
 
+Cypress.Commands.add(
+  'makeSnapshotWithCustomResolution',
+  ({ title, resolution }: MakeSnapshotWithCustomResolution) => {
+    const { width, height } = resolution;
+    cy.viewport(width, height);
+    cy.matchImageSnapshot(title);
+  }
+);
+
 Cypress.Commands.add('cssDisableMotion', (): void => {
   Cypress.on('window:before:load', (cyWindow) => {
     disableMotion(cyWindow);
@@ -148,13 +178,22 @@ declare global {
     interface Chainable {
       adjustViewport: () => Cypress.Chainable;
       cssDisableMotion: () => Cypress.Chainable;
+      getRequestCalls: (alias) => Cypress.Chainable;
       interceptAPIRequest: <T extends object>(
         props: InterceptAPIRequestProps<T>
       ) => Cypress.Chainable;
       interceptRequest: (method, path, mock, alias) => Cypress.Chainable;
       makeSnapshot: (title?: string) => void;
+      makeSnapshotWithCustomResolution: ({
+        title,
+        resolution
+      }: MakeSnapshotWithCustomResolution) => Cypress.Chainable;
       mount: ({ Component, options }: MountProps) => Cypress.Chainable;
-      moveSortableElement: ({ element, direction }) => void;
+      moveSortableElement: ({
+        element,
+        direction,
+        times
+      }: MoveSortableElementProps) => void;
       moveSortableElementUsingAriaLabel: ({ ariaLabel, direction }) => void;
       waitForRequest: (alias) => Cypress.Chainable;
     }

package/cypress/component/configuration.js

@@ -3,6 +3,7 @@ const { defineConfig } = require('cypress');
 const {
   addMatchImageSnapshotPlugin
 } = require('@simonsmith/cypress-image-snapshot/plugin');
+const cypressCodeCoverageTask = require('@cypress/code-coverage/task');
 
 module.exports = ({
   webpackConfig,
@@ -25,9 +26,12 @@ module.exports = ({
       setupNodeEvents: (on, config) => {
         addMatchImageSnapshotPlugin(on, config);
 
+        cypressCodeCoverageTask(on, config);
+
         on('before:browser:launch', (browser, launchOptions) => {
           if (browser.name === 'chrome' && browser.isHeadless) {
             launchOptions.args.push('--headless=new');
+            launchOptions.args.push('--force-color-profile=srgb');
           }
 
           return launchOptions;
@@ -37,8 +41,17 @@ module.exports = ({
       supportFile: `${mainCypressFolder}/support/component.tsx`
     },
     env: {
-      ...env,
-      baseUrl: 'http://localhost:9092'
+      baseUrl: 'http://localhost:9092',
+      codeCoverage: {
+        exclude: [
+          'cypress/**/*.*',
+          'packages/**',
+          'node_modules',
+          '**/*.js',
+          '**/*.spec.tsx'
+        ]
+      },
+      ...env
     },
     reporter: 'mochawesome',
     reporterOptions: {

package/cypress/component/excludeNodeModulesFromCoverage.js

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const path = require('path');
+
+const filePath = process.argv[2];
+
+const { error: logError } = console;
+
+try {
+  const outFile = fs.readFileSync(path.resolve(filePath)).toString();
+  const outFileJson = JSON.parse(outFile);
+
+  const coveragesWithoutNodeModules = Object.entries(outFileJson)
+    .map(([key, value]) => {
+      if (key.includes('node_modules')) {
+        return undefined;
+      }
+
+      return [key, value];
+    })
+    .filter((v) => v);
+
+  const finalOutJson = coveragesWithoutNodeModules.reduce(
+    (acc, [key, value]) => ({
+      ...acc,
+      [key]: value
+    }),
+    {}
+  );
+
+  fs.writeFileSync(
+    path.resolve(filePath),
+    JSON.stringify(finalOutJson, null, 2)
+  );
+} catch (error) {
+  logError(error.message);
+}

package/cypress/e2e/commands/configuration.ts

@@ -138,6 +138,102 @@ Cypress.Commands.add(
   }
 );
 
+interface Contact {
+  admin?: boolean;
+  alias?: string | null;
+  authenticationType?: 'local' | 'ldap';
+  email: string;
+  enableNotifications?: boolean;
+  GUIAccess?: boolean;
+  language?: string;
+  name: string;
+  password: string;
+}
+
+Cypress.Commands.add(
+  'addContact',
+  ({
+    admin = true,
+    alias = null,
+    authenticationType = 'local',
+    email,
+    enableNotifications = true,
+    GUIAccess = true,
+    language = 'en_US',
+    name,
+    password
+  }: Contact): Cypress.Chainable => {
+    const contactAdmin = admin ? 1 : 0;
+    const contactAlias = alias === null ? name : alias;
+    const contactEnableNotifications = enableNotifications ? 1 : 0;
+    const contactGUIAccess = GUIAccess ? 1 : 0;
+
+    return cy
+      .executeActionViaClapi({
+        bodyContent: {
+          action: 'ADD',
+          object: 'CONTACT',
+          values: `${name};${contactAlias};${email};${password};${contactAdmin};${contactGUIAccess};${language};${authenticationType}`
+        }
+      })
+      .then(() => {
+        const contactParams = {
+          enable_notifications: contactEnableNotifications
+        };
+        Object.entries(contactParams).map(([paramName, paramValue]) => {
+          if (paramValue === null) {
+            return null;
+          }
+
+          return cy.executeActionViaClapi({
+            bodyContent: {
+              action: 'SETPARAM',
+              object: 'CONTACT',
+              values: `${name};${paramName};${paramValue}`
+            }
+          });
+        });
+
+        return cy.wrap(null);
+      });
+  }
+);
+
+interface ContactGroup {
+  alias?: string | null;
+  contacts: string[];
+  name: string;
+}
+
+Cypress.Commands.add(
+  'addContactGroup',
+  ({ alias = null, contacts, name }: ContactGroup): Cypress.Chainable => {
+    const contactGroupAlias = alias === null ? name : alias;
+
+    return cy
+      .executeActionViaClapi({
+        bodyContent: {
+          action: 'ADD',
+          object: 'CG',
+          values: `${name};${contactGroupAlias}`
+        }
+      })
+      .then(() => {
+        contacts.map((contact) => {
+          return cy.executeActionViaClapi({
+            bodyContent: {
+              action: 'ADDCONTACT',
+              object: 'CG',
+              values: `${name};${contact}`
+            }
+          });
+        });
+
+        return cy.wrap(null);
+      });
+  }
+);
+
 interface Host {
   activeCheckEnabled?: boolean;
   address?: string;
@@ -208,6 +304,26 @@ Cypress.Commands.add(
   }
 );
 
+interface HostGroup {
+  alias?: string | null;
+  name: string;
+}
+
+Cypress.Commands.add(
+  'addHostGroup',
+  ({ alias = null, name }: HostGroup): Cypress.Chainable => {
+    const hostGroupAlias = alias === null ? name : alias;
+
+    return cy.executeActionViaClapi({
+      bodyContent: {
+        action: 'ADD',
+        object: 'HG',
+        values: `${name};${hostGroupAlias}`
+      }
+    });
+  }
+);
+
 interface ServiceTemplate {
   activeCheckEnabled?: boolean;
   checkCommand?: string | null;
@@ -329,6 +445,45 @@ Cypress.Commands.add(
   }
 );
 
+interface ServiceGroup {
+  alias?: string | null;
+  hostsAndServices: string[][];
+  name: string;
+}
+
+Cypress.Commands.add(
+  'addServiceGroup',
+  ({
+    alias = null,
+    hostsAndServices,
+    name
+  }: ServiceGroup): Cypress.Chainable => {
+    const serviceGroupAlias = alias === null ? name : alias;
+
+    return cy
+      .executeActionViaClapi({
+        bodyContent: {
+          action: 'ADD',
+          object: 'SG',
+          values: `${name};${serviceGroupAlias}`
+        }
+      })
+      .then(() => {
+        hostsAndServices.map((hostAndService) => {
+          return cy.executeActionViaClapi({
+            bodyContent: {
+              action: 'ADDSERVICE',
+              object: 'SG',
+              values: `${name};${hostAndService[0]},${hostAndService[1]}`
+            }
+          });
+        });
+
+        return cy.wrap(null);
+      });
+  }
+);
+
 Cypress.Commands.add(
   'applyPollerConfiguration',
   (pollerName = 'Central'): Cypress.Chainable => {
@@ -345,8 +500,12 @@ declare global {
   namespace Cypress {
     interface Chainable {
       addCheckCommand: (props: CheckCommand) => Cypress.Chainable;
+      addContact: (props: Contact) => Cypress.Chainable;
+      addContactGroup: (props: ContactGroup) => Cypress.Chainable;
       addHost: (props: Host) => Cypress.Chainable;
+      addHostGroup: (props: HostGroup) => Cypress.Chainable;
       addService: (props: Service) => Cypress.Chainable;
+      addServiceGroup: (props: ServiceGroup) => Cypress.Chainable;
       addServiceTemplate: (props: ServiceTemplate) => Cypress.Chainable;
       addTimePeriod: (props: TimePeriod) => Cypress.Chainable;
       applyPollerConfiguration: (props?: string) => Cypress.Chainable;