@tangelo/tangelo-configuration-toolkit 1.17.1 → 1.19.0

package/src/modules/git/index.js

@@ -1,4 +1,6 @@
 const {execSync, spawn} = require('child_process');
+const fs                = require('fs-extra');
+const globby            = require('globby');
 const inquirer          = require('inquirer');
 const path              = require('path');
 
@@ -36,172 +38,203 @@ const cmdExec = commands => new Promise(resolve => {
 });
 
 
-module.exports = function git (argv) {
-
-  if (argv.init) {
-    const remoteTdiUrl = `${_paths.gitremote}/${_paths.tdi}.git`;
-    let branches;
-
-    try { branches = execSync('git ls-remote --heads ' + remoteTdiUrl, {encoding: 'UTF-8'}); }
-    catch (e) { _error(' '); } // execSync already prints an error to the console
-
-    branches = branches
-      .match(/refs\/heads\/\S+/g)
-      .map(s => s.replace('refs/heads/', ''))
-      .sort((a, b) => {
-        const aRelease = /^release\//.test(a), bRelease = /^release\//.test(b);
-        if (aRelease && bRelease) return a > b ? -1 : 1;
-        if (aRelease) return -1;
-        if (bRelease) return 1;
-        return a > b ? 1 : -1;
-      })
-    ;
-    inquirer
-      .prompt([{
-        message: 'Choose a branch for TDI submodule: ', name: 'branch', type: 'list',
-        choices: branches, pageSize: 3, loop: false
-      }])
-      .then(a => {
-        _write();
-        cmdExec([
-          ['git init', 'Initialize repo:'],
-          [`git remote add origin ${_paths.gitremote.replace(/\//, ':')}/${path.basename(process.cwd()).replace(/\W/, '-')}.git`],
-          [`git submodule add -b ${a.branch} ${remoteTdiUrl}`, 'Add TDI submodule:'],
-          ['git commit -m "added tdi submodule"', 'Commit:']
-        ])
-          .then(() => {
-            _info(`Next steps:
-          1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd()).replace(/\W/, '-')}", with options for including README/.gitignore disabled.
-          2. Open this folder in Sourcetree (ctrl+O), and push master branch to origin.
-        `.replace(/^\s{8}/gm, ''));
-          });
-      });
+function init () {
+  const remoteTdiUrl = `${_paths.gitremote}/${_paths.tdi}.git`;
+  let branches;
+
+  try { branches = execSync('git ls-remote --heads ' + remoteTdiUrl, {encoding: 'UTF-8'}); }
+  catch (e) { _error(' '); } // execSync already prints an error to the console
+
+  branches = branches
+    .match(/refs\/heads\/\S+/g)
+    .map(s => s.replace('refs/heads/', ''))
+    .sort((a, b) => {
+      const aRelease = /^release\//.test(a), bRelease = /^release\//.test(b);
+      if (aRelease && bRelease) return a > b ? -1 : 1;
+      if (aRelease) return -1;
+      if (bRelease) return 1;
+      return a > b ? 1 : -1;
+    })
+  ;
+  inquirer
+    .prompt([{
+      message: 'Choose a branch for TDI submodule: ', name: 'branch', type: 'list',
+      choices: branches, pageSize: 3, loop: false
+    }])
+    .then(a => {
+      _write();
+      cmdExec([
+        ['git init', 'Initialize repo:'],
+        [`git remote add origin ${_paths.gitremote.replace(/\//, ':')}/${path.basename(process.cwd()).replace(/\W/, '-')}.git`],
+        [`git submodule add -b ${a.branch} ${remoteTdiUrl}`, 'Add TDI submodule:'],
+        ['git commit -m "added tdi submodule"', 'Commit:']
+      ])
+        .then(() => {
+          _info(`Next steps:
+        1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd()).replace(/\W/, '-')}", with options for including README/.gitignore disabled.
+        2. Open this folder in Sourcetree (ctrl+O), and push master branch to origin.
+      `.replace(/^\s{8}/gm, ''));
+        });
+    });
+}
+
+
+function reset () {
+  _info('Reset and clean repo:');
+  cmdExec([
+    ['git reset --hard'],
+    ['git clean -f -d']
+  ]);
+}
+
+
+function clone ({clone: repoName}) {
+
+  if (typeof repoName !== 'string') _error('Pass a repository name!');
+
+  _info('Clone a client repository and do basic project initialization');
+  cmdExec([
+    // Clone repository
+    ['git clone git@bitbucket.org:tangelosoftware/' + repoName + '.git']
+  ])
+    .then(() => {
+      // Change directory for the next commands, it should have the same name as the clone argument from commandline at this point
+      process.chdir('./' + repoName);
+      cmdExec([
+      // Retrieve TDI submodule for this client
+        ['git submodule update --init', 'Fetch submodules such as TDI'],
+        // Create symlinks for TDI
+        ['tct b -s', 'Create TDI symlinks'],
+        // Create Oxygen project file and set name equal to repo name
+        [`tct b -x ${repoName}`, 'Create Oxygen project file'],
+      ]);
+    })
+    .catch(e => {throw e;})
+  ;
+}
+
+
+/**
+ * Updates the repository to the latest commit.
+ * Checks the version of the Fonto instances and warns if there are changes.
+ */
+function updateRepo () {
+  const readFontoVersionFromFile = relPath => fs.readJSONSync(path.join(_paths.repo, 'config/cmscustom', relPath)).sdkVersion;
+  const fontoLocations = globby.sync('*/*/fonto/manifest.json', {cwd: path.join(_paths.repo, 'config/cmscustom')});
+  const fontoVersions = {};
+  fontoLocations.forEach(p => {fontoVersions[p] = readFontoVersionFromFile(p);});
+  const tdiLogBeforeUpdate = _git.commitTdi.local();
+
+  _info(`Fetch all`);
+  const cmdFetch = execGitCommand('fetch -pf --all', _paths.repo);
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+  _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 = _git.commitLocal();
+  _write([_formatDate(repoLog.date), repoLog.tags, repoLog.hash].filter(v=>v).join(' - '));
+
+  if (fontoLocations.find(p => fontoVersions[p] !== readFontoVersionFromFile(p))) _warn(`\nChanges in Fonto instance versions have been pulled. Therefore you must execute ${'tct fonto --init'.cyan} before building and deploying Fonto.`);
+
+  // update submodule recursively (set to version that belongs to repo)
+  execGitCommand(`submodule update --recursive`, _paths.repo);
+
+  // clear memoize cache; which is filled with the old TDI data due to tdiLogBeforeUpdate
+  _git.commitTdi.local.clear();
+  const tdiLog = _git.commitTdi.local();
+
+  _info(`\nTDI submodule:`);
+  _write(`Submodule in repo-commit: ${[_formatDate(tdiLog.date), tdiLog.tags, tdiLog.hash].filter(v=>v).join(' - ')}`);
+
+  if (tdiLog.date < tdiLogBeforeUpdate.date) {
+    _write(`Restore TDI submodule because it was newer before the repository update:`);
+    execGitCommand(`checkout ${tdiLogBeforeUpdate.hash}`, path.join(_paths.repo, _paths.tdi));
+    _write(`Submodule checked out: ${[_formatDate(tdiLogBeforeUpdate.date), tdiLogBeforeUpdate.tags, tdiLogBeforeUpdate.hash].filter(v=>v).join(' - ')}\n`);
   }
-
-  if (argv.reset) {
-    _info('Reset and clean repo:');
-    cmdExec([
-      ['git reset --hard'],
-      ['git clean -f -d']
-    ]);
+  else {
+    _write(`Submodule in repo-commit is checked out\n`);
   }
 
-  if (argv.clone) {
-    if (typeof argv.clone !== 'string') _error('Pass a repository name!');
-
-    _info('Clone a client repository and do basic project initialization');
-    cmdExec([
-      // Clone repository
-      ['git clone git@bitbucket.org:tangelosoftware/' + argv.clone + '.git']
-    ])
-      .then(() => {
-        // Change directory for the next commands, it should have the same name as the clone argument from commandline at this point
-        process.chdir('./' + argv.clone);
-        cmdExec([
-        // Retrieve TDI submodule for this client
-          ['git submodule update --init', 'Fetch submodules such as TDI'],
-          // Create symlinks for TDI
-          ['tct b -s', 'Create TDI symlinks'],
-          // Create Oxygen project file and set name equal to repo name
-          [`tct b -x ${argv.clone}`, 'Create Oxygen project file'],
-        ]);
-      })
-      .catch(e => {throw e;})
-    ;
-  }
+  const tdiBranch = getTdiBranch();
+  _info(`\nTDI branch ${tdiBranch.name} is ${tdiBranch.commitsBehind} commits behind.\nUpdate TDI submodule to latest version with ${'tct git --update-submodule'.cyan}`);
+}
+
+
+/**
+ * Updates a submodule in a Git repository. Allows for custom date ranges (for testing) and branch upgrades, and applies migrations to the repository if necessary.
+ *
+ * @param {string[]} options.dates - An array of two strings representing the start and end dates for the custom date range.
+ * @param {string} options.updateSubmodule - The target branch name for the submodule update.
+ */
+function updateSubmodule({dates = [], updateSubmodule: toBranchName}) {
+  const [dateCustomFrom, dateCustomTo] = dates;
+  const branch = getTdiBranch(typeof toBranchName !== 'boolean' && toBranchName);
+  const branchUpgrade = branch.from ? branch.from.name < branch.name : false;
+
+  if (branchUpgrade) _info(`Current branch '${branch.from.name}' will be updated to '${branch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(branch.commonAncestor.date)}`);
+  _info(`Branch ${branch.name} is ${branch.commitsBehind} commits behind.\n`);
+
+  // Set branch in .gitmodules file; This ensures submodule update will follow this branch to the latest commit
+  const setBranch = execGitCommand(`submodule set-branch -b ${branch.name} tangelo-default-implementation`, _paths.repo);
+  if (setBranch.error) _error(`Set branch failed: ${setBranch.error}`);
+
+  if (branch.commitsBehind > 0 || dateCustomFrom) {
+    const dateBeforeUpdate = _git.commitTdi.local().date;
+
+    // update submodule
+    const updateSubmoduleMsg = execGitCommand(`submodule update --remote`, _paths.repo);
+    if (updateSubmoduleMsg.error) _error(`Update submodule failed\n${updateSubmoduleMsg.error}`);
+    if (updateSubmoduleMsg) _info(`TDI submodule updated:\n${updateSubmoduleMsg}\n`);
+
+    // tdiMigrationFilePath should exist in latest commits of releases 5.3+; As we updated to the latest version this should work
+    const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
+    const fromDate = dateCustomFrom ? new Date(dateCustomFrom) : branch.commonAncestor?.date ?? dateBeforeUpdate;
+    const toDate = dateCustomTo ? new Date(dateCustomTo) : new Date();
+
+    _info(`TDI commits requiring migration between ${_formatDate(fromDate)} and ${_formatDate(toDate)}`);
+    // Filter the migrations that should be applied/considered; Also display older releases migrations
+    // For a branch upgrade, all the migrations need to be executed from the beginning of the target branch, not just within the given date range
+    const migrationsFiltered = migrations.filter(m => m.releases.find(r => {
+      const withinDateRange = fromDate < new Date(r.date) && new Date(r.date) < toDate;
+      const isTargetBranch = `release/${r.release}` === branch.name;
+      return branchUpgrade ?
+        isTargetBranch || (branch.from.name <= `release/${r.release}` && `release/${r.release}` < branch.name && withinDateRange) :
+        isTargetBranch && withinDateRange
+      ;
+    }));
+
+    let relevantMigrationCount = 0;
+    // Apply callback for migrations
+    migrationsFiltered
+      .sort((a, b) => Date(a.releases[0].date) > Date(b.releases[0].date) ? 1 : -1)
+      .forEach(m => {
+        const date = _formatDate(new Date(m.releases.filter(r => branch.name >= `release/${r.release}`)[0].date));
+        relevantMigrationCount += m.callback(date, relevantMigrationCount+1) === 1 ? 1 : 0;
+      });
 
-  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}`);
-
-        const tdiDateBeforeUpdate = _git.commitTdi.local().date;
-        // update local TDI commit data
-        _git.commitTdi.local(true);
-
-        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
-        const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
-        if (migrations) {
-          const fromTdiDate = tdiFromDateCustom ? new Date(tdiFromDateCustom) : (tdiBranch.commonAncestor) ? tdiBranch.commonAncestor.date: tdiDateBeforeUpdate;
-          const toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new 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
-            .sort((a, b) => Date(a.releases[0].date)>Date(b.releases[0].date)?1:-1)
-            .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`);
-      }
+    // Output message based on whether or not migrations are required
+    if (migrationsFiltered.length === 0) {
+      _write(`-- No commits require migrations --`);
     } 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 = _git.commitLocal(true);
-      _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 = _git.commitTdi.local(true);
-      _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'`);
+      _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 (https://tangelo-software.atlassian.net/wiki/x/qQnE)`);
     }
+
+  } else {
+    _info(`Your TDI submodule is already up to date`);
   }
+}
+
+
+module.exports = function git (argv) {
+
+  if (argv.init) init();
+  if (argv.reset) reset();
+  if (argv.clone) clone(argv);
+  if (argv.updateRepo) updateRepo();
+  if (argv.updateSubmodule) updateSubmodule(argv);
+
 };

package/src/modules/migrate/index.js

@@ -51,7 +51,7 @@ module.exports = function migrate (argv) {
         a.script = cmdlScript.value;
       }
 
-      let filter = path.join(_paths.apply, argv.filter??'**').toFws(); // Default set filter with filter added to the command argument -f
+      let filter = path.join(_paths.apply, argv.filter??'**').toFws; // Default set filter with filter added to the command argument -f
 
       if (a.filter === 'projects' && _repoconfig.length > a.projects.length) {
       // push paths of chosen active documents to projectFolders (only if not all projects are chosen)

package/src/modules/sql/index.js

@@ -61,10 +61,7 @@ module.exports = function sql (argv) {
         .prompt([
           {
             message: 'Choose projects: ', name: 'projects', type: 'checkbox', validate: v => !!v[0],
-            choices:
-            _repoconfig.projects
-              ? _repoconfig.projects.map(p => ({name: p.name, value: p})) // when using repoconfig file (old)
-              : _repoconfig.map(p => ({name: `${p.customer_name} ${p.project_name}`, value: p}))
+            choices: _repoconfig.map(p => ({name: `${p.customer_name} ${p.project_name}`, value: p}))
           },
           {message: 'Database TNS name: ', name: 'db', default: _appconfig.defaultDatabase},
           {message: 'TANCMS password: ', name: 'pw', default: 'tancms'}

package/src/lib/style-string-getters.js

@@ -1,15 +0,0 @@
-/* eslint-disable no-control-regex */
-
-const styles = {bold: 1, underline: 4, black: 30, red: 31, green: 32, yellow: 33, blue: 34, magenta: 35, cyan: 36, white: 37, lblack: 90, lred: 91, lgreen: 92, lyellow: 93, lblue: 94, lmagenta: 95, lcyan: 96, lwhite: 97};
-
-for (const name in styles ) {
-  const style = styles[name];
-
-  String.prototype.__defineGetter__(name, function () {
-    return `\x1b[${style}m${this}\x1b[0m`;
-  });
-}
-
-String.prototype.__defineGetter__('nostyle', function () {
-  return this.replace(/[\u001b\u009b][[()#;?]*(?:\d{1,4}(?:;\d{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
-});