@eui/tools 6.4.1 → 6.4.3

package/.version.properties

@@ -1 +1 @@
-6.4.1
+6.4.3

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.4.3 (2023-02-23)
+
+##### Chores
+
+* **other:**
+  * limit the number of commit output for MS Teams message - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([616070b3](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/616070b3daaaae67fc5753c490290c14f9790738))
+  * adapted teams notification message for exception and commits outpuy - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([58f0f958](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/58f0f9587af636311c43d9a979ea3d4acb5c5511))
+
+* * *
+* * *
+## 6.4.2 (2023-02-22)
+
+##### Chores
+
+* **other:**
+  * adapted MS Teams notifications to fetch teams hook from CSDR_ARGS process variable - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([836a9c6a](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/836a9c6a2ca634c6a09be95a1cc3062ff311ec78))
+
+* * *
+* * *
 ## 6.4.1 (2023-02-22)
 
 ##### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eui/tools",
-    "version": "6.4.1",
+    "version": "6.4.3",
     "tag": "latest",
     "license": "EUPL-1.1",
     "description": "eUI common tools and scripts",
@@ -42,7 +42,6 @@
         "chai": "4.3.7",
         "nyc": "15.1.0",
         "node-fetch": "2.6.9",
-        "sendmail": "1.6.1",
         "svg-sprite": "2.0.2",
         "imagemin": "7.0.1",
         "imagemin-svgo": "9.0.0",

package/sandbox.js

@@ -1181,8 +1181,22 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 //   })
 
 
+// const teamsUtils = require('./scripts/utils/notification/teams-utils');
+
+// Promise.resolve()
+//   .then(() => {
+//     console.log(teamsUtils.getChannelHook('pipeline-ui-edui'));
+//   })
+
 Promise.resolve()
   .then(() => {
-    const config = configUtils.global.getConfigOptions();
-    console.log(config);
+
+    var startTime = moment('03-01-2021 01:01:01', 'DD-MM-YYYY hh:mm:ss');
+    var endTime = moment('03-01-2021 01:04:53', 'DD-MM-YYYY hh:mm:ss');
+
+    var secondsDiff = endTime.diff(startTime, 's');
+
+    const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+    const minSec = getMinSec(secondsDiff);
+    console.log(minSec);
   })

package/scripts/utils/notification/common.js

@@ -12,6 +12,7 @@ module.exports.getMessage = (options) => {
     mainText: null,
     detailTitle: null,
     detailText: null,
+    detailTextArray: [],
     text: options.text || null,
     status: null,
     statusColor: null
@@ -41,55 +42,57 @@ module.exports.getMessage = (options) => {
     switch (options.exception) {
       case 'NO_VALID_COMMIT_FOUND':
         message.detailTitle = 'NO VALID COMMIT FOUND!';
-        message.detailText = 'No valid commit found since last release tag\n' + '...Check trace file for details';
+        message.detailTextArray.push('No valid commit found since last release tag');
         break;
 
       case 'NO_ISSUE_FOUND':
         message.detailTitle = 'NO ISSUE FOUND!';
-        message.detailText = 'No issue found on commits since last release tag\n' + '...Check trace file for details\n';
+        message.detailTextArray.push('No issue found on commits since last release tag');
+        message.detailTextArray.push('Commit details:');
         if (options.metadata.commits && options.metadata.commits.length !== 0) {
-          message.detailText += options.metadata.commits.map((commit) => {
+          const commits = options.metadata.commits.map((commit) => {
             return metadataUtils.commit.formatCommit(commit);
-          }).join('\n');
+          });
+          message.detailTextArray = [...message.detailTextArray, ...commits];
         }
         break;
 
       case 'GLOBAL_PIPELINE_DISABLED':
         message.detailTitle = 'PIPELINE GLOBALLY DISABLED!';
-        message.detailText = 'Due to maintenance, all pipeline jobs have been temporary disabled - retry later';
+        message.detailTextArray.push('Due to maintenance, all pipeline jobs have been temporary disabled - retry later');
         break;
 
       case 'PACKAGE_LOCKED':
         message.detailTitle = 'CONCURRENT BUILD DETECTED FOR PACKAGE - ABORTING!';
-        message.detailText = 'Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared';
+        message.detailTextArray.push('Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared');
         break;
 
       case 'MULTIPLE_LOCAL_EUI_VERSIONS_FOUND':
         message.detailTitle = 'MULTIPLE eUI VERSIONS FOUND IN LOCAL PROJECT - ABORTING!';
-        message.detailText = 'Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects';
+        message.detailTextArray.push('Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects');
         break;
 
       case 'BRANCH_NOT_PROVIDED':
         message.detailTitle = 'RELEASE BRANCH missing - ABORTING!';
-        message.detailText = 'Package release needs to have a branch to build from as parameter from Bamboo';
+        message.detailTextArray.push('Package release needs to have a branch to build from as parameter from Bamboo');
         break;
 
       case 'REMOTE_ENVTARGET_NOT_MASTER_BRANCH':
         message.detailTitle = 'REMOTE envTarget type branchis different from master - ABORTING!';
-        message.detailText = 'For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question';
+        message.detailTextArray.push('For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question');
         break;
 
       case 'AUDIT_DEPENDENCIES_GATES_FAILED':
-        message.detailTitle = 'Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!';
-        message.detailText = 'Check logs for more info or contact eUI support for detailed checks';
+        message.detailTitle = 'AUDIT DEPENDENCIES GATES FAILED';
+        message.detailTextArray.push('Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!');
         break;
 
       default:
         message.detailTitle = 'GENERAL ERROR!';
-        message.detailText = options.exception;
+        message.detailTextArray.push(options.exception);
     };
 
-
+    message.detailText = message.detailTextArray.join('\n');
 
   } else {
 
@@ -106,12 +109,16 @@ module.exports.getMessage = (options) => {
 
       if (options.metadata && options.metadata.commits && options.metadata.commits.length !== 0) {
         message.detailTitle = 'Commit history since last release tag';
-        message.detailText = options.metadata.commits.map((commit) => {
+        const formattedCommits = options.metadata.commits.map((commit) => {
           return metadataUtils.commit.formatCommit(commit);
-        }).join('\n ');
+        });
+        message.detailText = formattedCommits.join('\n ');
+        message.detailTextArray = formattedCommits;
 
         if (options.metadata.issues && options.metadata.issues.length !== 0) {
-          message.detailText += '\nExtracted issues : ' + options.metadata.issues;
+          const extractedIssuesText = 'Extracted issues : ' + options.metadata.issues;
+          message.detailText += '\n' + extractedIssuesText;
+          message.detailTextArray.push(extractedIssuesText);
         }
       }
     }

package/scripts/utils/notification/mail-utils.js

@@ -8,7 +8,7 @@ let { dryRun, debug} = tools.getArgs();
 
 
 const sendCore = (subject, body, recipient) => {
-  const sendmail = require('sendmail')();
+  const sendmail = require('sendmail')(); // if used in the future and needed this deps is required : "sendmail": "1.6.1"
 
   tools.logInfo(`Sending mail to : ${recipient}`);
   tools.logInfo('Message subject / body :');

package/scripts/utils/notification/message-stack.js

@@ -10,9 +10,6 @@ const tools = require('../tools');
 const innerConfig = require('./config');
 const innerTeamsUtils = require('./teams-utils');
 
-// ARGS
-const { dryRun, debug, notificationActive } = tools.getArgs();
-
 
 // ---------------------------------------------------------------------------------------
 // MESSAGE BUFFER
@@ -25,6 +22,7 @@ const messageContent = {
   startTimestamp: null,
   endTimestamp: null,
   duration: null,
+  durationSeconds: null,
   durationMinSec: null
 };
 
@@ -36,7 +34,9 @@ module.exports.endStack = () => {
   messageContent.endTimestamp = moment();
   messageContent.duration = messageContent.endTimestamp - messageContent.startTimestamp;
   const start = messageContent.startTimestamp, end = messageContent.endTimestamp;
-  messageContent.durationMinSec = `${end.diff(start, 'm')}m:${end.diff(start, 's')}s`;
+  messageContent.durationSeconds = end.diff(start, 's');
+  const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+  messageContent.durationMinSec = getMinSec(messageContent.durationSeconds);
 }
 
 module.exports.pushMessage = (message) => {
@@ -44,36 +44,23 @@ module.exports.pushMessage = (message) => {
 }
 
 
-
 const sendMessage = (config) => {
-
   if (config.CLIENT === 'SLACK') {
     return Promise.resolve();
   }
 
-  if (!notificationActive) {
-    tools.logInfo('No notifications config found...skipping');
-
-    if (debug) {
-      console.log(messageContent);
-    }
-
-    return Promise.resolve();
+  return Promise.resolve()
+    .then(() => {
+      if (config.CLIENT === 'MSTEAMS') {
+        return innerTeamsUtils.sendMessage(config, messageContent);
 
-  } else {
-    return Promise.resolve()
-      .then(() => {
-        if (config.CLIENT === 'MSTEAMS') {
-          return innerTeamsUtils.sendMessage(config, messageContent);
-
-        } else if (config.CLIENT === 'MAIL') {
-          // TODO IF MAIL NOTIF IS NEEDED...
-        }
-      })
-      .catch((e) => {
-        throw e;
-      })
-  }
+      } else if (config.CLIENT === 'MAIL') {
+        // TODO IF MAIL NOTIF IS NEEDED...
+      }
+    })
+    .catch((e) => {
+      throw e;
+    })
 }
 
 

package/scripts/utils/notification/package.js

@@ -56,8 +56,6 @@ module.exports.sendPackageDiffReportMessage = (pkg, diffMetadata) => {
   if (config.CLIENT === 'SLACK') {
     return Promise.resolve()
       .then(() => {
-        const config = innerConfig.getPackageConfig(pkg);
-
         return slackUtils.sendPackageDiffReportMessage(
           diffMetadata,
           config.SLACK_HOOK,

package/scripts/utils/notification/teams-utils.js

@@ -9,10 +9,22 @@ const configUtils = require('../../csdr/config/config-utils');
 const { dryRun, debug} = tools.getArgs();
 
 
-const getChannelHook = (channelName) => {
-  // const { msteamsHookMap } = tools.getArgs();
-  // TODO channel/hook map parser (incoming from _CSDR_ARGS gitlab defs)
-  return msteamsHook;
+const getChannelHook = module.exports.getChannelHook = (channelName) => {
+  const { msteamsHooksArray } = tools.getArgs();
+
+  const msteamsHook = msteamsHooksArray.filter((h) => {
+    return Object.keys(h)[0] === channelName;
+  })[0];
+
+  if (!msteamsHook) {
+    tools.logInfo(`Channel hook can't be found for ${channelName} - check _CSDR_ARGS entries in gitlab pipeline configuration`);
+
+    // TODO set default channels in global config by type
+    // const globalConfig = configUtils.global.getConfigOptions();
+    return;
+  }
+
+  return msteamsHook[channelName];
 }
 
 
@@ -42,11 +54,19 @@ const createPayload = (messageContent) => {
   const version = finalMessage.version;
 
   // set commit history
-  const commitHistory = "```" + finalMessage.detailText;
+  let commitHistory = [], exceptionDetails = [];
+  if (status === statuses.success) {
+    commitHistory = finalMessage.detailTextArray;
+  } else {
+    exceptionDetails = finalMessage.detailTextArray;
+  }
 
   // set summary
   const itemName = messageContent.buffer[0].scope;
-  const summary = `${status.emoji} :: ${status.text} - ${itemName} - ${version}`;
+  let summary = `${status.emoji} :: ${status.text} - ${itemName}`;
+  if (version) {
+    summary +=  ` - ${version}`;
+  }
 
   // set release sections
   const publications = messageContent.buffer.filter(m => m.text !== null && m.text.indexOf(':rocket:') > -1);
@@ -59,11 +79,29 @@ const createPayload = (messageContent) => {
     }
   });
 
-  sections.push({
-    "startGroup": true,
-    "activityTitle": "Commit history since last release tag",
-    "activityText": commitHistory
-  });
+  if (commitHistory.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": "Commit history since last release tag"
+    });
+    commitHistory.slice(0, 5).forEach((commit) => {
+      sections.push({
+        "activityText": commit
+      });
+    });
+  }
+
+  if (exceptionDetails.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": finalMessage.detailTitle
+    });
+    exceptionDetails.forEach((exd) => {
+      sections.push({
+        "activityText": exd
+      });
+    });
+  }
 
   sections.push({
     "startGroup": true,
@@ -91,15 +129,19 @@ module.exports.sendMessage = (config, messageContent) => {
   tools.logTitle('Sending MS teams message');
 
   const channelHook = getChannelHook(config.MSTEAMS_CHANNEL);
+
+  if (!channelHook) {
+    return Promise.resolve();
+  }
+
   const payload = createPayload(messageContent);
 
+  if (debug) {
+    console.log(messageContent);
+    console.log(JSON.parse(JSON.stringify(payload, null, 2)));
+  }
+
   return Promise.resolve()
-    .then(() => {
-      if (debug) {
-        console.log(messageContent);
-        console.log(JSON.parse(JSON.stringify(payload, null, 2)));
-      }
-    })
     .then(() => {
       const host = configUtils.global.getConfigOptions().MSTEAMS_HOST;
 

package/scripts/utils/tools.js

@@ -68,8 +68,24 @@ function getArgs() {
 
   if (processArgs) {
     processArgs.split(',').forEach((item) => {
-      const itemSplit = item.split(':');
-      args[itemSplit[0].trim()] = itemSplit[1].trim();
+      // check if it's defined as array - example format : someArray:test1=test1|test2=test2
+      if (item.indexOf('Array') > 0) {
+        const arrayItems = item.split(':')[1];
+        const subItems = arrayItems.split('|');
+        const array = [];
+        subItems.forEach((sub) => {
+          const subItemSplit = sub.split('=');
+          const newItem = {};
+          newItem[subItemSplit[0].trim()] = subItemSplit[1].trim();
+          array.push(newItem);
+        })
+        args[item.split(':')[0]] = array;
+
+      // otherwise normal key/value pairs - example format : test1:test1,test2:test2
+      } else {
+        const itemSplit = item.split(':');
+        args[itemSplit[0].trim()] = itemSplit[1].trim();
+      }
     })
   }
 

package/scripts/utils/notification/mailstack.js

@@ -1,127 +0,0 @@
-'use strict';
-
-// GLOBAL
-const moment = require('moment');
-
-// LOCAL
-const mailUtils = require('./mail-utils');
-const tools = require('../tools');
-
-// INNER
-const innerConfig = require('./config');
-
-// FETCH ARGS
-let { dryRun, debug } = tools.getArgs();
-
-// ---------------------------------------------------------------------------------------
-// MAIL BUFFER
-// - used for storing all message happening during a run
-// - used for MS Teams mail notifications, to avoid multiple message send for a single run
-// ---------------------------------------------------------------------------------------
-
-const mailContent = {
-  buffer: [],
-  exception: null,
-};
-
-module.exports.startMailStack = () => {
-  mailContent.buffer.push(`CSDR RUN - START - ${moment(new Date()).format("DD/MM/YYYY HH:mm")}\n\n`);
-}
-
-module.exports.endMailStack = () => {
-  mailContent.buffer.push(`CSDR RUN - END - ${moment(new Date()).format("DD/MM/YYYY HH:mm")}`);
-}
-
-module.exports.bufferMessage = (message) => {
-  if (message.text) {
-    mailContent.buffer.push(message.text);
-
-  } else {
-    mailContent.buffer.push(message.mainTitle);
-    mailContent.buffer.push(message.mainText);
-
-    if (message.detailTitle) {
-      mailContent.buffer.push(message.detailTitle);
-      mailContent.buffer.push(message.detailText);
-    }
-
-    if (message.scope) {
-      let subMessage = `>> <b>${message.scope}</b>`;
-      if (message.version) {
-        subMessage += `- <b>${message.version}</b>`;
-      }
-      mailContent.buffer.push(subMessage);
-    }
-  }
-
-  if (message.exception) {
-    mailContent.exception = message.exception;
-  }
-}
-
-
-const sendMailStack = (config, scope, target) => {
-  return Promise.resolve()
-  .then(() => {
-    let statusColor = 'green', status = 'SUCCESS';
-
-    if (mailContent.exception) {
-      statusColor = 'red';
-      status = 'ERROR';
-    }
-
-    // const subject = `RELEASE <b style="color: ${statusColor};">${status}</b> - <b style="color:blue;">${scope}</b> - branch: <b styles="color: blue;">${target}</b>`;
-    const subject = `Release of **${scope}**  for ${target} ---- status : ${status}`;
-    let fullMessage = `<pre>${mailContent.buffer.join('\n')}</pre>`;
-
-    if (mailContent.exception) {
-      fullMessage += mailContent.exception;
-    }
-
-    if (config.CLIENT === 'MAIL') {
-      return mailUtils.sendMessage(subject, fullMessage, config.MAIL_ADDRESS);
-
-    } else {
-      console.log(fullMessage);
-    }
-  })
-
-  .catch((e) => {
-    throw e;
-  })
-}
-
-
-
-
-module.exports.sendMailStackPackage = (pkg, branches) => {
-
-  // getting package notification config
-  const config = innerConfig.getPackageConfig(pkg);
-
-  return Promise.resolve()
-    .then(() => {
-      return sendMailStack(config, pkg.name, branches.branch);
-    })
-
-    .catch((e) => {
-      throw e;
-    })
-}
-
-
-module.exports.sendMailStackProject = (project, envTarget) => {
-
-  // getting package notification config
-  const config = innerConfig.getProjectConfig(project);
-
-  return Promise.resolve()
-    .then(() => {
-      return sendMailStack(config, project.name, envTarget);
-    })
-
-    .catch((e) => {
-      throw e;
-    })
-}
-