@eui/tools 6.2.11 → 6.2.12

package/scripts/csdr/release/package/release-package.js

@@ -1,207 +1,43 @@
 'use strict';
 
-// GLOBAL
-const path = require('path');
-
 // UTILS
-const utils = require('../../../utils');
-
-// CSDR RELATED
-const configUtils = require('../../config/config-utils');
-const metadataUtils = require('../../metadata/metadata-utils');
+const tools = require('../../../utils/tools');
 
 // INNER MODULES
-const innerCommon = require('./common');
-const innerUi = require('./ui');
-const innerRemote = require('./remote');
+const innerReleaseVirtualRemote = require('./release-virtual-remote');
+const innerReleaseUi = require('./release-ui');
 
 
 module.exports.run = () => {
 
-    // fetching package from config based on default arg
-    const pkg = configUtils.packages.getPackage();
-
-    // checking if the package can be retrieved from args
-    if (!pkg.name) {
-      utils.tools.logError('ERROR : "package" NOT PROVIDED as argument !!!');
-      process.exit(1);
-    }
-
-    // Get branches flags
-    const branches = innerCommon.getBranches();
-
-    // Get envTarget (used by remotes)
-    const envTarget = innerCommon.getEnvTarget();
-
-    // Get compositeType (used by remotes)
-    const compositeType = innerCommon.getCompositeType();
-
-
-    // local saved vars
-    var newVersion, pkgMetadata, pkgCompositeDeps;
-
-
-    return Promise.resolve()
-      // LOGGING CURRENT eUI TOOLS VERSION
-      .then(() => {
-        utils.tools.logVersion();
-      })
-
-      // RELEASE PACKAGE START
-      .then(() => {
-        return innerCommon.init(pkg, envTarget, compositeType);
-      })
-
-      // FOR UI and REMOTES clone metadata repositories
-      .then(() => {
-        return innerCommon.cloneMetadataRepos();
-      })
-
-      // PRE-RELEASE & COMMON CHECKS
-      .then(() => {
-        return innerCommon.preReleaseChecks(pkg);
-      })
-
-      // FETCHING COMMITS METADATA
-      .then(() => {
-        return metadataUtils.commit.getMetadata(pkg);
-      })
-      .then((metadata) => {
-        pkgMetadata = metadata;
-      })
-
-      // COMMIT METADATA CHECKS
-      .then(() => {
-        return innerCommon.commitMetadataChecks(pkg);
-      })
-      .then((metadata) => {
-        pkgMetadata = metadata;
-      })
-
-
-      // EXECUTING PRE BUILD SCRIPT IF AVAILABLE
-      .then(() => {
-        return innerCommon.preBuild(pkg);
-      })
-
-
-      // INSTALL dependencies by type
-      .then(() => {
-        if (pkg.remote) {
-          return innerRemote.install(pkg, envTarget, compositeType);
-
-        } else {
-          return innerUi.install(pkg, branches.isMaster);
-        }
-      })
-      .then((compositeDeps) => {
-        // storing for later use
-        pkgCompositeDeps = compositeDeps;
-      })
-
-
-      // BUILD PACKAGE
-      .then(() => {
-        return utils.buildPackage.build(pkg, branches.isMaster);
-      })
-
-
-      // EXECUTING SONAR ANALYSIS
-      .then(() => {
-        return utils.sonar.run(pkg, branches.isMaster);
-      })
-
-
-      // GENERATE and UPDATE new version
-      .then(() => {
-        return innerCommon.updateVersion(pkg, pkgMetadata, envTarget);
-      })
-      .then((version) => {
-        // storing version for later use
-        newVersion = version;
-      })
-
-
-      // GENERATE CHANGELOG
-      .then(() => {
-        if (!pkg.remote) {
-          return innerCommon.generateChangelog(pkg, newVersion, pkgMetadata);
-        }
-      })
-
-
-      // EXECUTING GLOBAL POST BUILD
-      .then(() => {
-        return innerCommon.postBuild(pkg, newVersion);
-      })
-
-
-      // STORING METADATA ASSETS
-      .then(() => {
-        return innerCommon.storeMetadataAssets(pkg, pkgCompositeDeps);
-      })
-
-
-      // PUBLISH PACKAGE
-      .then(() => {
-        return utils.publish.publish(pkg);
-      })
-
-
-      // EXECUTING POST PUBLISH SCRIPT IF AVAILABLE
-      .then(() => {
-        return utils.publish.postPublish(pkg);
-      })
-
-
-
-      // GIT OPERATIONS
-      .then(() => {
-        return innerCommon.runGitOperations(pkg, newVersion);
-      })
-
-      // STORING CENTRALIZED METADATA
-      .then(() => {
-        // get run duration
-        const duration = utils.pipeline.getTimerDuration();
-        return innerCommon.storeMetadata(pkg, newVersion, pkgMetadata, pkgCompositeDeps, duration, envTarget);
-      })
-
-      // STORING PACKAGE HISTORY
-      .then(() => {
-        if (branches.isMaster && pkg.remote) {
-          return innerCommon.generateDiffReport(pkg, newVersion);
-        }
-      })
+  // TESTING a release pipeline in DRY-RUN mode :
+  // virtual remotes
+  // npm run pkg:release mywp-dashboard -- --euiVersion 15.x --dryRun --branch master --remoteBuild true --virtual true --envTarget DEV --skipInstall
 
-      // COMMITING METADATA
-      .then(() => {
-        return innerCommon.commitMetadata(pkg, newVersion);
-      })
+  // normal UI package / old style remote
+  // npm run pkg:release csdr-core-ui -- --dryRun --branch develop --skipInstall
 
-      .catch((e) => {
-        throw e;
-      })
 
+  return Promise.resolve()
+    // LOGGING CURRENT eUI TOOLS VERSION
+    .then(() => {
+      tools.logVersion();
+    })
 
-      // EXPORT ADDITIONAL PIPELINE VARIABLES
-      .then(() => {
-        return innerCommon.exportPipelineVariables(pkg, compositeType);
-      })
+    // CHECKING if release is for virtual remote or normal UI package (including normal remote)
+    .then(() => {
+      let { remoteBuild, virtual } = tools.getArgs();
+      remoteBuild = tools.convertBooleanArg(remoteBuild);
+      virtual = tools.convertBooleanArg(virtual);
 
-      // SEND SUCCESS NOTIFICATION
-      .then(() => {
-        return innerCommon.sendSuccessNotification(pkg, newVersion, pkgMetadata)
-          .then(() => {
-            innerCommon.close(pkg);
-          });
-      })
+      if (remoteBuild && virtual) {
+        return innerReleaseVirtualRemote.run();
+      } else {
+        return innerReleaseUi.run();
+      }
+    })
 
-      .catch((e) => {
-        return innerCommon.sendErrorNotification(pkg, e, pkgMetadata)
-          .then(() => {
-            innerCommon.close(pkg);
-            process.exit(1);
-          });
-      })
+    .catch((e) => {
+      throw e;
+    })
 }

package/scripts/csdr/release/package/release-ui.js

@@ -0,0 +1,199 @@
+'use strict';
+
+// GLOBAL
+const path = require('path');
+
+// UTILS
+const utils = require('../../../utils');
+
+// CSDR RELATED
+const configUtils = require('../../config/config-utils');
+const metadataUtils = require('../../metadata/metadata-utils');
+
+// INNER MODULES
+const innerCommon = require('./common');
+const innerUi = require('./ui');
+const innerRemote = require('./remote');
+
+
+module.exports.run = () => {
+    utils.tools.logBanner('Starting UI pipeline');
+
+    // fetching package from config based on default arg
+    const pkg = configUtils.packages.getPackage();
+
+    // checking if the package can be retrieved from args
+    if (!pkg.name) {
+      utils.tools.logError('ERROR : "package" NOT PROVIDED as argument !!!');
+      process.exit(1);
+    }
+
+    // Get branches flags
+    const branches = innerCommon.getBranches();
+
+    // Get envTarget (used by remotes)
+    const envTarget = innerCommon.getEnvTarget();
+
+    // Get compositeType (used by remotes)
+    const compositeType = innerCommon.getCompositeType();
+
+
+    // local saved vars
+    var newVersion, pkgMetadata, pkgCompositeDeps;
+
+
+    return Promise.resolve()
+
+      // RELEASE PACKAGE START
+      .then(() => {
+        return innerCommon.init(pkg, envTarget, compositeType);
+      })
+
+      // FOR UI and REMOTES clone metadata repositories
+      .then(() => {
+        return innerCommon.cloneMetadataRepos();
+      })
+
+      // PRE-RELEASE & COMMON CHECKS
+      .then(() => {
+        return innerCommon.preReleaseChecks(pkg);
+      })
+
+      // FETCHING COMMITS METADATA
+      .then(() => {
+        return metadataUtils.commit.getMetadata(pkg);
+      })
+      .then((metadata) => {
+        pkgMetadata = metadata;
+      })
+
+      // COMMIT METADATA CHECKS
+      .then(() => {
+        return innerCommon.commitMetadataChecks(pkg);
+      })
+      .then((metadata) => {
+        pkgMetadata = metadata;
+      })
+
+
+      // EXECUTING PRE BUILD SCRIPT IF AVAILABLE
+      .then(() => {
+        return innerCommon.preBuild(pkg);
+      })
+
+
+      // INSTALL dependencies by type
+      .then(() => {
+        if (pkg.remote) {
+          return innerRemote.install(pkg, envTarget, compositeType);
+
+        } else {
+          return innerUi.install(pkg, branches.isMaster);
+        }
+      })
+      .then((compositeDeps) => {
+        // storing for later use
+        pkgCompositeDeps = compositeDeps;
+      })
+
+
+      // BUILD PACKAGE
+      .then(() => {
+        return utils.buildPackage.build(pkg, branches.isMaster);
+      })
+
+
+      // EXECUTING SONAR ANALYSIS
+      .then(() => {
+        return utils.sonar.run(pkg, branches.isMaster);
+      })
+
+
+      // GENERATE and UPDATE new version
+      .then(() => {
+        return innerCommon.updateVersion(pkg, pkgMetadata, envTarget);
+      })
+      .then((version) => {
+        // storing version for later use
+        newVersion = version;
+      })
+
+
+      // GENERATE CHANGELOG
+      .then(() => {
+        if (!pkg.remote) {
+          return innerCommon.generateChangelog(pkg, newVersion, pkgMetadata);
+        }
+      })
+
+
+      // EXECUTING GLOBAL POST BUILD
+      .then(() => {
+        return innerCommon.postBuild(pkg, newVersion);
+      })
+
+
+      // STORING METADATA ASSETS
+      .then(() => {
+        return innerCommon.storeMetadataAssets(pkg, pkgCompositeDeps);
+      })
+
+
+      // PUBLISH PACKAGE
+      .then(() => {
+        return utils.publish.publish(pkg);
+      })
+
+
+      // EXECUTING POST PUBLISH SCRIPT IF AVAILABLE
+      .then(() => {
+        return utils.publish.postPublish(pkg);
+      })
+
+
+
+      // GIT OPERATIONS
+      .then(() => {
+        return innerCommon.runGitOperations(pkg, newVersion);
+      })
+
+      // STORING CENTRALIZED METADATA
+      .then(() => {
+        // get run duration
+        const duration = utils.pipeline.getTimerDuration();
+        return innerCommon.storeMetadata(pkg, newVersion, pkgMetadata, pkgCompositeDeps, duration, envTarget);
+      })
+
+      // STORING PACKAGE HISTORY
+      .then(() => {
+        if (branches.isMaster && pkg.remote) {
+          return innerCommon.generateDiffReport(pkg, newVersion);
+        }
+      })
+
+      // COMMITING METADATA
+      .then(() => {
+        return innerCommon.commitMetadata(pkg, newVersion);
+      })
+
+      // EXPORT ADDITIONAL PIPELINE VARIABLES
+      .then(() => {
+        return innerCommon.exportPipelineVariables(pkg, compositeType);
+      })
+
+      // SEND SUCCESS NOTIFICATION
+      .then(() => {
+        return innerCommon.sendSuccessNotification(pkg, newVersion, pkgMetadata)
+          .then(() => {
+            innerCommon.close(pkg);
+          });
+      })
+
+      .catch((e) => {
+        return innerCommon.sendErrorNotification(pkg, e, pkgMetadata)
+          .then(() => {
+            innerCommon.close(pkg);
+            process.exit(1);
+          });
+      })
+}

package/scripts/csdr/release/package/release-virtual-remote.js

@@ -0,0 +1,154 @@
+'use strict';
+
+// GLOBAL
+const path = require('path');
+
+// UTILS
+const utils = require('../../../utils');
+
+// CSDR RELATED
+const configUtils = require('../../config/config-utils');
+
+// INNER MODULES
+const innerCommon = require('./common');
+const innerRemote = require('./remote');
+
+
+
+
+module.exports.run = () => {
+    utils.tools.logBanner('Starting virtual remote pipeline');
+
+    // fetching package from config based on default arg
+    const pkg = configUtils.remotes.getRemote();
+
+    // checking if the package can be retrieved from args
+    if (!pkg.name) {
+      utils.tools.logError('ERROR : "package" NOT PROVIDED as argument !!!');
+      process.exit(1);
+    }
+
+    // Get branches flags
+    const branches = innerCommon.getBranches();
+
+    // Get envTarget (used by remotes)
+    const envTarget = innerCommon.getEnvTarget();
+
+    // Get compositeType (used by remotes)
+    const compositeType = innerCommon.getCompositeType();
+
+
+    // local saved vars
+    var newVersion, pkgMetadata, pkgCompositeDeps;
+
+
+    return Promise.resolve()
+
+      // RELEASE PACKAGE START
+      .then(() => {
+        return innerCommon.init(pkg, envTarget, compositeType);
+      })
+
+      // FOR UI and REMOTES clone metadata repositories
+      .then(() => {
+        return innerCommon.cloneMetadataRepos();
+      })
+
+
+      // EXECUTING PRE BUILD SCRIPT IF AVAILABLE
+      .then(() => {
+        return innerCommon.preBuild(pkg);
+      })
+
+
+      // INSTALL dependencies by type
+      .then(() => {
+        return innerRemote.install(pkg, envTarget, compositeType);
+      })
+      .then((compositeDeps) => {
+        // storing for later use
+        pkgCompositeDeps = compositeDeps;
+      })
+
+
+      // BUILD PACKAGE
+      .then(() => {
+        return utils.buildPackage.build(pkg, true);
+      })
+
+
+      // GENERATE and UPDATE new version
+      .then(() => {
+        return innerCommon.updateVersion(pkg, pkgMetadata, envTarget);
+      })
+      .then((version) => {
+        // storing version for later use
+        newVersion = version;
+      })
+
+
+      // EXECUTING GLOBAL POST BUILD
+      .then(() => {
+        return innerCommon.postBuild(pkg, newVersion);
+      })
+
+
+      // STORING METADATA ASSETS
+      .then(() => {
+        return innerCommon.storeMetadataAssets(pkg, pkgCompositeDeps);
+      })
+
+
+      // PUBLISH PACKAGE
+      .then(() => {
+        return utils.publish.publish(pkg);
+      })
+
+
+      // EXECUTING POST PUBLISH SCRIPT IF AVAILABLE
+      .then(() => {
+        return utils.publish.postPublish(pkg);
+      })
+
+
+      // STORING CENTRALIZED METADATA
+      .then(() => {
+        // get run duration
+        const duration = utils.pipeline.getTimerDuration();
+        return innerCommon.storeMetadata(pkg, newVersion, pkgMetadata, pkgCompositeDeps, duration, envTarget);
+      })
+
+      // STORING PACKAGE HISTORY
+      .then(() => {
+        if (branches.isMaster && pkg.remote) {
+          return innerCommon.generateDiffReport(pkg, newVersion);
+        }
+      })
+
+      // COMMITING METADATA
+      .then(() => {
+        return innerCommon.commitMetadata(pkg, newVersion);
+      })
+
+
+      // EXPORT ADDITIONAL PIPELINE VARIABLES
+      .then(() => {
+        return innerCommon.exportPipelineVariables(pkg, compositeType);
+      })
+
+      // SEND SUCCESS NOTIFICATION
+      .then(() => {
+        return innerCommon.sendSuccessNotification(pkg, newVersion, pkgMetadata)
+          .then(() => {
+            innerCommon.close(pkg);
+          });
+      })
+
+      .catch((e) => {
+        return innerCommon.sendErrorNotification(pkg, e, pkgMetadata)
+          .then(() => {
+            innerCommon.close(pkg);
+            process.exit(1);
+          });
+      })
+}

package/scripts/csdr/version/package-common.js

@@ -54,7 +54,7 @@ const writePackageJson = (pkg, newVersion, isSnapshot, isNextBranch, isSupportBr
       if (!pkg.parent) {
         return Promise.resolve()
           .then(() => {
-            return writePackageJsonCore(newVersion, pkg.paths.pkgDirectory, isSnapshot, isNextBranch, isSupportBranch, isHotfixBranch, envTarget);
+            return writePackageJsonCore(newVersion, pkg.paths.root, isSnapshot, isNextBranch, isSupportBranch, isHotfixBranch, envTarget);
           })
           .then(() => {
             if (!pkg.element && !pkg.config) {
@@ -68,7 +68,7 @@ const writePackageJson = (pkg, newVersion, isSnapshot, isNextBranch, isSupportBr
       } else {
         return Promise.resolve()
           .then(() => {
-            return writePackageJsonCore(newVersion, pkg.paths.pkgDirectory, isSnapshot, isNextBranch, isSupportBranch, isHotfixBranch, envTarget);
+            return writePackageJsonCore(newVersion, pkg.paths.root, isSnapshot, isNextBranch, isSupportBranch, isHotfixBranch, envTarget);
           })
           .then(() => {
             let linkedPackages = Object.keys(pkg.packages)
@@ -119,18 +119,18 @@ const writePomXml = (pkg, newVersion, isSnapshot, isForceTimestamp = true) => {
 
     .then((mavenSettingsFile) => {
 
-      tools.logInfo(`Executing mvn versions on : ${pkg.paths.pkgDirectory}`);
+      tools.logInfo(`Executing mvn versions on : ${pkg.paths.root}`);
 
-      execa.shellSync('mvn versions:set -T1 -DnewVersion=' + newVersion + ' -s ' + mavenSettingsFile, { cwd: pkg.paths.pkgDirectory });
-      execa.shellSync('mvn versions:commit -T1' + ' -s ' + mavenSettingsFile, { cwd: pkg.paths.pkgDirectory });
+      execa.shellSync('mvn versions:set -T1 -DnewVersion=' + newVersion + ' -s ' + mavenSettingsFile, { cwd: pkg.paths.root });
+      execa.shellSync('mvn versions:commit -T1' + ' -s ' + mavenSettingsFile, { cwd: pkg.paths.root });
 
       if (isForceTimestamp) {
         // timestamp file is forced to have at least one file to commit, as snapshot release
         // for backend can keep the same version until its latest
-        const tsversionFile = path.resolve(pkg.paths.pkgDirectory, '.tsversion');
+        const tsversionFile = path.resolve(pkg.paths.root, '.tsversion');
         tools.writeFileContent(tsversionFile, Date.now().toString());
 
-        const versionFile = path.resolve(pkg.paths.pkgDirectory, '.version.properties');
+        const versionFile = path.resolve(pkg.paths.root, '.version.properties');
         tools.writeFileContent(versionFile, newVersion);
       }
     })
@@ -170,14 +170,14 @@ module.exports.getCurrentVersion = (pkg) => {
         if (pkg.build && pkg.build.nodejs) {
           tools.logInfo('UI package => extracting from package.json');
 
-          const pathPkgJson = path.resolve(pkg.paths.pkgDirectory, 'package.json');
+          const pathPkgJson = path.resolve(pkg.paths.root, 'package.json');
           const pkgJson = require(pathPkgJson);
           currentVersion = pkgJson.version;
 
           // by default maven java backend is taken into account
         } else {
           tools.logInfo('Backend => extracting pom.xml');
-          const xmlContent = tools.getXMLJsContent(path.join(pkg.paths.pkgDirectory, 'pom.xml'));
+          const xmlContent = tools.getXMLJsContent(path.join(pkg.paths.root, 'pom.xml'));
 
           tools.logInfo('Content found:');
           console.log(xmlContent);
@@ -188,7 +188,7 @@ module.exports.getCurrentVersion = (pkg) => {
       } else {
         tools.logInfo('UI package => extracting from package.json');
 
-        const pathPkgJson = path.resolve(pkg.paths.pkgDirectory, 'package.json');
+        const pathPkgJson = path.resolve(pkg.paths.root, 'package.json');
         const pkgJson = require(pathPkgJson);
         currentVersion = pkgJson.version;
       }