@tangelo/tangelo-configuration-toolkit 1.13.0 → 1.14.1

package/src/modules/git/index.js

@@ -2,7 +2,10 @@ const {execSync, spawn} = require('child_process');
 const {chdir}   = require('process');
 const inquirer  = require('inquirer');
 const path      = require('path');
+const fs        = require('fs-extra');
 
+const execGitCommand  = require('../../lib/exec-git-command');
+const getTdiBranch    = require('../../lib/get-tdi-branch');
 
 const cmdExec = commands => new Promise(resolve => {
   let promise = new Promise(resolve => resolve());
@@ -21,7 +24,7 @@ const cmdExec = commands => new Promise(resolve => {
       cp.stdout.on('data', log);
       cp.stderr.setEncoding('utf8');
       cp.stderr.on('data', log);
-      cp.on('close', code => {
+      cp.on('close', () => {
         if (!a[i+1] || a[i+1][1]) _write();
         resolve();
       });
@@ -33,6 +36,8 @@ const cmdExec = commands => new Promise(resolve => {
   });
 });
 
+const tdiMigrationFilePath  = path.join(_paths.repo, _paths.tdi, 'tct/git/tdiCommitsRequiringMigration.js');
+
 module.exports = function git (argv) {
 
   if (argv.init) {
@@ -112,4 +117,94 @@ module.exports = function git (argv) {
         throw e;
       });
   }
+
+  if (argv.update) {
+    const [update, tdiFromDateCustom, tdiToDateCustom] = `${argv.update}`.split(/\s/);
+
+    if (update === `tdi`) {
+
+      const tdiBranch = getTdiBranch(argv.branch);
+      const tdiBranchUpgrade = tdiBranch.from ? (tdiBranch.from.name < tdiBranch.name) : false;
+
+      if (tdiBranchUpgrade) _info(`Current branch '${tdiBranch.from.name}' will be updated to '${tdiBranch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(tdiBranch.commonAncestor.date)}`);
+      _info(`Branch ${tdiBranch.name} is ${tdiBranch.commitsBehind} commits behind.`);
+
+      // Set branch in .gitmodules file; This ensures submodule update will follow this branch to the latest commit
+      const setBranch = execGitCommand(`submodule set-branch -b ${tdiBranch.name} tangelo-default-implementation`, _paths.repo);
+      if (setBranch.error) _error(`Set branch failed: ${setBranch.error}`);
+
+      if (tdiBranch.commitsBehind > 0 || tdiFromDateCustom) {
+        // update submodule
+        const updateSubmoduleMsg = execGitCommand(`submodule update --remote`, _paths.repo);
+        if (updateSubmoduleMsg.error && !tdiFromDateCustom) _error(`Update submodule failed\n${updateSubmoduleMsg.error}`);
+
+        if (!tdiFromDateCustom) _info(`TDI submodule updated:\n${updateSubmoduleMsg}`);
+
+        // tdiMigrationFilePath should exist in latest commits of releases 5.3+; As we updated to the latest version this should work
+        if (fs.existsSync(tdiMigrationFilePath)) {
+          const migrations = require(tdiMigrationFilePath);
+          const fromTdiDate = tdiFromDateCustom ? new Date(tdiFromDateCustom) : (tdiBranch.commonAncestor) ? tdiBranch.commonAncestor.date: _git.commitTdi.local().date;
+          const toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new Date(execGitCommand(`log -1 --format=%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['date']).date);
+
+          _info(`TDI commits requiring migration between ${_formatDate(fromTdiDate)} and ${_formatDate(toTdiDate)}`);
+          // Filter the migrations that should be applied/considered; Also display older releases migrations
+          const migrationsFiltered = migrations
+            .filter((m) => m.releases.find((r) => {
+              const time = new Date(r.date).getTime();
+              return ((tdiBranchUpgrade)
+                ? `release/${r.release}` == tdiBranch.name || (tdiBranch.from.name <= `release/${r.release}` && `release/${r.release}` < tdiBranch.name && (fromTdiDate.getTime() < time && time < toTdiDate.getTime()))
+                : `release/${r.release}` == tdiBranch.name && (fromTdiDate.getTime() < time && time < toTdiDate.getTime())
+              );
+            })
+            );
+
+          let relevantMigrationCount = 0;
+          // Apply callback for migrations
+          migrationsFiltered
+            .forEach((m) => {
+              const date = _formatDate(new Date(m.releases.filter((r) => tdiBranch.name >= `release/${r.release}`)[0].date));
+              relevantMigrationCount += (m.callback(date, relevantMigrationCount+1)) === 1 ? 1 : 0;
+            });
+
+          // Output message based on whether or not migrations are required
+          if (migrationsFiltered.length === 0) {
+            _write(`-- No commits require migrations --`);
+          } else {
+            _info(`\n${relevantMigrationCount} relevant migration(s) out of ${migrationsFiltered.length} migration(s) are shown.`);
+            _info(`See confluence page 'TDI commits requiring migration' for more detailed information`);
+          }
+
+        } else {
+          _error(`Cannot find required files in TDI submodule.`);
+        }
+      } else {
+        _info(`Your TDI submodule is already up to date`);
+      }
+    } else {
+      if (argv.branch) _warn(`Branch argument '${argv.branch}' is ignored for a repository update.`);
+
+      // Fetch all
+      _info(`Fetch all`);
+      const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo));
+      if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+      // pull repo
+      _info(`Pull repository`);
+      const cmdPull = execGitCommand(`pull`, _paths.repo);
+      if (cmdPull.error) _warn(`Pull failed\n${cmdPull.error}`);
+
+      _info(`Checked out at commit:`);
+      const repoLog = execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['tags', 'hash', 'date']);
+      _write(`${_formatDate(repoLog.date)} - ${repoLog.tags} - ${repoLog.hash}`);
+
+      _info(`Retrieve submodules that belong to this repo-commit`); // update submodule recursively (set to version that belongs to repo)
+      _write(execGitCommand(`submodule update --recursive`, path.join(_paths.repo)));
+      _info(`Submodule checked out at commit:`);
+      const tdiLog = execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['tags', 'hash', 'date']);
+      _write(`${_formatDate(tdiLog.date)} - ${tdiLog.tags} - ${tdiLog.hash}`);
+      const tdiBranch = getTdiBranch();
+
+      _info(`\nTDI branch ${tdiBranch.name} is ${tdiBranch.commitsBehind} commits behind.\nUpdate TDI to latest version with 'tct g -u tdi'`);
+    }
+  }
 };

package/src/modules/info/index.js

@@ -1,202 +1,201 @@
-const fs      = require('fs-extra');
-const globby  = require('globby');
-const path    = require('path');
-const {Table} = require('console-table-printer');
-
-const execGitCommand  = require('../../lib/exec-git-command');
-const c               = require('../deploy/config');
-const {remote}        = require('../deploy/execute');
-
-
-const getGitInfo = () => {
-  // Version info TDI submodule
-  const gitSubmoduleInfo = new Table({
-    columns: [
-      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
-      {name: 'value', alignment: 'left'}
-    ],
-  });
-
-  // Fetch all
-  execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
-
-  // Get branches containing TDI HEAD commit
-  const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, path.join(_paths.repo, _paths.tdi)).match(/release\/[^\s]+/gsm);
-  if (!releaseBranches) _error('Could not retrieve TDI release branches');
-  // Get the first possible branch; prefer release/5.1 over release/5.2:
-  releaseBranches.sort((a, b) => a.name > b.name ? 1 : -1);
-  const firstBranch = {name: releaseBranches[0]};
-  // Get number of commits behind
-  firstBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${firstBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
-
-  // Create table rows for TDI submodule info
-  gitSubmoduleInfo.addRow({
-    property: 'Commit date',
-    value: _git.commitTdi.local().date.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'})
-  });
-  if (firstBranch) {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch',
-      value: firstBranch.name
-    });
-    gitSubmoduleInfo.addRow({
-      property: 'Commits behind',
-      value: firstBranch.commitsBehind
-    });
-  } else {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch could not be determined',
-      value: ''
-    });
-  }
-
-  // Print TDI submodule info
-  gitSubmoduleInfo.printTable();
-};
-
-const getFileExtractInfo = (sorting) => {
-  // version info miscellaneous
-  const projects = new Set;
-  const types = new Set;
-  const versionInfoConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/version/versionInfo.js');
-  const versionInfo = new Table({
-    columns: [
-      {name: 'path', alignment: 'left'},
-      {name: 'type', alignment: 'left'},
-      {name: 'version', alignment: 'left'},
-      {name: 'sort'}
-    ],
-    disabledColumns: ['sort'],
-    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
-  });
-
-  if (fs.existsSync(versionInfoConfigPath)) {
-    const config = require(versionInfoConfigPath);
-
-    config.forEach(v => {
-      const location = path.join(_paths.repo, v.glob);
-
-      globby
-        .sync(location)
-        .forEach(f => {
-          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
-          const path = filePathExtract.groups.path || '';
-          const project = filePathExtract.groups.project || '';
-
-          const fileContent = fs.readFileSync(f).toString();
-          v.extracts.forEach(e => {
-            const extract = fileContent.match(e.regex);
-            if (extract) {
-              projects.add(project); // Store the projects where versioninfo is found
-              types.add(e.type); // Store the types for which versioninfo is found
-              versionInfo.addRow({ // Create row with version information to output
-                path,
-                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
-                type: e.type,
-                version: extract.groups.version
-              });
-            }
-          });
-        });
-    });
-
-    if (sorting=='project') {
-      // For projects containing version information
-      projects.forEach(p => {
-        versionInfo.addRow({ // Add empty row after project
-          path: '',
-          sort: `${p}_3`,
-          type: '',
-          version: ''
-        });
-        versionInfo.addRow({ // Add row with project name
-          path: `-- ${p}:`,
-          sort: `${p}_1`,
-          type: '',
-          version: ''
-        }, {
-          color: 'yellow'
-        });
-      });
-    }
-    else if (sorting=='type') {
-      types.forEach(t => {
-        versionInfo.addRow({ // Add empty row after type
-          path: '',
-          sort: `${t}_3`,
-          type: '',
-          version: ''
-        });
-      });
-    }
-    versionInfo.printTable();
-  }
-  else {
-    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
-  }
-};
-
-const getServerInfo = (server) => {
-  // Remote server info
-  // common setup
-  _write();
-  c.setServer(server);
-
-  if (!c.envDev) {
-    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
-    remote.add('sudo ~root/scripts/version.sh', '').process();
-  }
-  else {
-    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
-  }
-};
-
-
-module.exports = function info (argv) {
-
-  if (argv.doctypes) {
-    _info('Document type information for this git repository\n');
-
-    const doctypesInfo = new Table({
-      columns: [
-        {name: 'id', alignment: 'right'},
-        {name: 'name', alignment: 'left'},
-        {name: 'paths', alignment: 'left'}
-      ],
-    });
-
-    globby
-      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
-      .forEach((p, i, a) => {
-        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
-          .forEach((dtRow, i, a) => {
-            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
-            const id      = dtRow.match(/(\d+) id/)?.[1];
-            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
-            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
-            const prPath  = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1].replace('prepare_xincludes.xsl','');
-
-            doctypesInfo.addRows([
-              {id, name, paths: 'config/cmscustom/'+ prPath},
-              {paths: dbPath}
-            ]);
-
-            if (i!==a.length-1) doctypesInfo.addRow({});
-          });
-
-        if (i!==a.length-1) doctypesInfo.addRow({});
-      });
-
-
-    doctypesInfo.printTable();
-  }
-
-  if (argv.versions) {
-    _info('Version information for this git repository\n');
-
-    getGitInfo();
-    getFileExtractInfo(argv.versions);
-    getServerInfo(argv.server);
-  }
-
-};
+const fs      = require('fs-extra');
+const globby  = require('globby');
+const path    = require('path');
+const {Table} = require('console-table-printer');
+
+const execGitCommand  = require('../../lib/exec-git-command');
+const getTdiBranch    = require('../../lib/get-tdi-branch');
+const c               = require('../deploy/config');
+const {remote}        = require('../deploy/execute');
+
+
+const getGitInfo = () => {
+  // Version info TDI submodule
+  const gitSubmoduleInfo = new Table({
+    columns: [
+      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
+      {name: 'value', alignment: 'left'}
+    ],
+  });
+
+  // Fetch all
+  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+  // Set branch name of firstBranch without 'remotes/origin/'
+  const tdiBranch = getTdiBranch();
+
+  // Get number of commits behind
+  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
+
+  // Create table rows for TDI submodule info
+  gitSubmoduleInfo.addRow({
+    property: 'Commit date',
+    value: _formatDate(_git.commitTdi.local().date)
+  });
+  if (tdiBranch) {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch',
+      value: tdiBranch.name
+    });
+    gitSubmoduleInfo.addRow({
+      property: 'Commits behind',
+      value: tdiBranch.commitsBehind
+    });
+  } else {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch could not be determined',
+      value: ''
+    });
+  }
+
+  // Print TDI submodule info
+  gitSubmoduleInfo.printTable();
+};
+
+const getFileExtractInfo = (sorting) => {
+  // version info miscellaneous
+  const projects = new Set;
+  const types = new Set;
+  const versionInfoConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/version/versionInfo.js');
+  const versionInfo = new Table({
+    columns: [
+      {name: 'path', alignment: 'left'},
+      {name: 'type', alignment: 'left'},
+      {name: 'version', alignment: 'left'},
+      {name: 'sort'}
+    ],
+    disabledColumns: ['sort'],
+    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
+  });
+
+  if (fs.existsSync(versionInfoConfigPath)) {
+    const config = require(versionInfoConfigPath);
+
+    config.forEach(v => {
+      const location = path.join(_paths.repo, v.glob);
+
+      globby
+        .sync(location)
+        .forEach(f => {
+          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
+          const path = filePathExtract.groups.path || '';
+          const project = filePathExtract.groups.project || '';
+
+          const fileContent = fs.readFileSync(f).toString();
+          v.extracts.forEach(e => {
+            const extract = fileContent.match(e.regex);
+            if (extract) {
+              projects.add(project); // Store the projects where versioninfo is found
+              types.add(e.type); // Store the types for which versioninfo is found
+              versionInfo.addRow({ // Create row with version information to output
+                path,
+                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
+                type: e.type,
+                version: extract.groups.version
+              });
+            }
+          });
+        });
+    });
+
+    if (sorting=='project') {
+      // For projects containing version information
+      projects.forEach(p => {
+        versionInfo.addRow({ // Add empty row after project
+          path: '',
+          sort: `${p}_3`,
+          type: '',
+          version: ''
+        });
+        versionInfo.addRow({ // Add row with project name
+          path: `-- ${p}:`,
+          sort: `${p}_1`,
+          type: '',
+          version: ''
+        }, {
+          color: 'yellow'
+        });
+      });
+    }
+    else if (sorting=='type') {
+      types.forEach(t => {
+        versionInfo.addRow({ // Add empty row after type
+          path: '',
+          sort: `${t}_3`,
+          type: '',
+          version: ''
+        });
+      });
+    }
+    versionInfo.printTable();
+  }
+  else {
+    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
+  }
+};
+
+const getServerInfo = (server) => {
+  // Remote server info
+  // common setup
+  _write();
+  c.setServer(server);
+
+  if (!c.envDev) {
+    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
+    remote.add('sudo ~root/scripts/version.sh', '').process();
+  }
+  else {
+    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
+  }
+};
+
+
+module.exports = function info (argv) {
+
+  if (argv.doctypes) {
+    _info('Document type information for this git repository\n');
+
+    const doctypesInfo = new Table({
+      columns: [
+        {name: 'id', alignment: 'right'},
+        {name: 'name', alignment: 'left'},
+        {name: 'paths', alignment: 'left'}
+      ],
+    });
+
+    globby
+      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
+      .forEach((p, i, a) => {
+        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
+          .forEach((dtRow, i, a) => {
+            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
+            const id      = dtRow.match(/(\d+) id/)?.[1];
+            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
+            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
+            const prPath  = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1].replace('prepare_xincludes.xsl', '');
+
+            doctypesInfo.addRows([
+              {id, name, paths: 'config/cmscustom/'+ prPath},
+              {paths: dbPath}
+            ]);
+
+            if (i!==a.length-1) doctypesInfo.addRow({});
+          });
+
+        if (i!==a.length-1) doctypesInfo.addRow({});
+      });
+
+
+    doctypesInfo.printTable();
+  }
+
+  if (argv.versions) {
+    _info('Version information for this git repository\n');
+
+    getGitInfo();
+    getFileExtractInfo(argv.versions);
+    getServerInfo(argv.server);
+  }
+
+};

package/src/modules/migrate/index.js

@@ -62,7 +62,7 @@ module.exports = function migrate (argv) {
           if (p.path_dbconfig.join('/') != p.path_cmscustom.join('/')) projectFolders.push(p.path_cmscustom.join('/'));
         });
         // Set filter to chosen active documents
-        filter = projectFolders.length == 1 ? `**/${projectFolders}/**` : `**/{${projectFolders.join(',')}}/**`;
+        filter = projectFolders.length === 1 ? `**/${projectFolders}/**` : `**/{${projectFolders.join(',')}}/**`;
       }
 
       _info(`Filter applied: ${filter}`);

package/src/modules/migrate/steps.js

@@ -52,9 +52,11 @@ module.exports = function steps (step, dry, filter) {
       }
 
       let filesModCount = 0;
-      for (let i=0; i<20 && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
+      let maxRepeat = 20;
+      for (let i=0; i<maxRepeat && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
         r.files = rif.sync(r).filter(f => f.hasChanged).map(f => f.file);
-        if (i==0) filesModCount = r.files.length; // save count only after first run (after this only subsets are processed)
+        if (i===0) filesModCount = r.files.length; // save count only after first run (after this only subsets are processed)
+        if (i===maxRepeat-1 && r.files[0]) _warn(`Repeated replacement stopped by safety limit - check file changes for too many content occurrences`);
         if (dry) break;
       }
 

package/src/modules/sql/index.js

@@ -18,9 +18,9 @@ const checkLog = (logFilePath, remove=true) => {
   if (fs.existsSync(logFilePath)) {
     const logFile = fs.readFileSync(logFilePath).toString();
     // Check for ORA- error messages
-    if (logFile.match(RegExp(`ORA-`, 'gm'))) {
+    if (logFile.match(/ORA-/g)) {
       // Select each ORA- error message and up to 6 lines before (the lines before may not contain ORA- themselves)
-      const errors = logFile.match(RegExp(`((?![^\n]*ORA-)[^\n]*\n){0,6}ORA-[^\n\r]*`, `gms`));
+      const errors = logFile.match(/(?:(?![^\n]*ORA-)[^\n]*\n){0,6}ORA-[^\n\r]*/gms);
       _info(`${errors.length} error(s) during SQL script:\n`);
       // Print each error + lines before:
       errors.forEach((e, i) => {