adding wdt version checking for validate and prepare model actions (#76)

Author: robertpatrick

electron/app/js/wdtPrepareModel.js

@@ -13,10 +13,12 @@ const i18n = require('./i18next.config');
 const childProcessExecutor = require('./childProcessExecutor');
 const fsUtils = require('./fsUtils');
 const { getLogger } = require('./wktLogging');
-const { getPrepareModelShellScript, getWdtCustomConfigDirectory, isWdtErrorExitCode } = require('./wktTools');
+const { getPrepareModelShellScript, getWdtCustomConfigDirectory, isWdtErrorExitCode, isWdtVersionCompatible} = require('./wktTools');
 const { getModelFileContent } = require('./project');
 const errorUtils = require('./errorUtils');
 
+const MINIMUM_WDT_PREPARE_VERSION = '2.0.0';
+
 const _secretsFileName = 'k8s_secrets.json';
 const _wkoDomainSpecFileName = 'wko-domain.yaml';
 const _vzApplicationSpecFileName = 'vz-application.yaml';
@@ -56,6 +58,11 @@ async function prepareModel(currentWindow, stdoutChannel, stderrChannel, prepare
     isSuccess: true
   };
   try {
+    const versionCheckResult = await isWdtVersionCompatible(MINIMUM_WDT_PREPARE_VERSION);
+    if (!versionCheckResult.isSuccess) {
+      return Promise.resolve(versionCheckResult);
+    }
+
     const exitCode = await childProcessExecutor.executeChildShellScript(currentWindow, getPrepareModelShellScript(),
       argList, env, stdoutChannel, { stderrEventName: stderrChannel });
 

electron/app/js/wdtValidateModel.js

@@ -7,12 +7,14 @@
 
 const fsUtils = require('./fsUtils');
 const { getLogger } = require('./wktLogging');
-const { getWdtCustomConfigDirectory, getValidateModelShellScript, isWdtErrorExitCode} = require('./wktTools');
+const { getWdtCustomConfigDirectory, getValidateModelShellScript, isWdtErrorExitCode, isWdtVersionCompatible} = require('./wktTools');
 const childProcessExecutor = require('./childProcessExecutor');
 const { getErrorMessage } = require('./errorUtils');
 
 const i18n = require('./i18next.config');
 
+const MINIMUM_WDT_VALIDATE_VERSION = '2.0.0';
+
 async function validateModel(currentWindow, stdoutChannel, stderrChannel, validateConfig) {
   const logger = getLogger();
   const { javaHome, oracleHome, projectDirectory, modelFiles, variableFiles, archiveFiles } = validateConfig;
@@ -48,6 +50,11 @@ async function validateModel(currentWindow, stdoutChannel, stderrChannel, valida
     isSuccess: true
   };
   try {
+    const versionCheckResult = await isWdtVersionCompatible(MINIMUM_WDT_VALIDATE_VERSION);
+    if (!versionCheckResult.isSuccess) {
+      return Promise.resolve(versionCheckResult);
+    }
+
     const exitCode = await childProcessExecutor.executeChildShellScript(currentWindow, getValidateModelShellScript(),
       argList, env, stdoutChannel, { stderrEventName: stderrChannel });
 

electron/app/js/wktTools.js

@@ -6,21 +6,15 @@
 const { dialog } = require('electron');
 const path = require('path');
 const fsPromises = require('fs/promises');
+
+const fsUtils = require('./fsUtils');
 const i18n = require('./i18next.config');
 const osUtils = require('./osUtils');
-
-/* global __dirname */
-const jsDir = __dirname;
-
-const fsUtils = require(path.join(jsDir, 'fsUtils'));
-const {
-  downloadWdtRelease,
-  getWdtLatestReleaseName,
-  getWitLatestReleaseName,
-  getWkoLatestReleaseImageName,
-  updateTools
-} = require(path.join(jsDir, 'wktToolsInstaller'));
-const { getLogger } = require(path.join(jsDir, 'wktLogging'));
+const WktApp = require('./wktApp');
+const { getLogger } = require('./wktLogging');
+const { getErrorMessage } = require('./errorUtils');
+const { downloadWdtRelease, getWdtLatestReleaseName, getWitLatestReleaseName, getWkoLatestReleaseImageName,
+  updateTools } = require('./wktToolsInstaller');
 
 const scriptExtension = osUtils.isWindows() ? '.cmd' : '.sh';
 const VERSION_FILE_NAME = 'VERSION.txt';
@@ -64,6 +58,45 @@ function isWitErrorExitCode(exitCode) {
   return exitCode !== 0;
 }
 
+async function isWdtVersionCompatible(minimumVersion) {
+  const wdtVersionFileName = path.join(getWdtDirectory(), 'VERSION.txt');
+  const versionRegex = /^WebLogic Deploy Tooling (?<version>[\d]+.[\d]+.[\d]+(-SNAPSHOT)?)$/;
+  const result = {
+    isSuccess: true
+  };
+
+  return new Promise(resolve => {
+    fsUtils.exists(wdtVersionFileName).then(doesExist => {
+      if (!doesExist) {
+        result.isSuccess = false;
+        result.reason = i18n.t('wkt-tools-wdt-version-file-missing-error', { file: wdtVersionFileName });
+        return resolve(result);
+      }
+      fsPromises.readFile(wdtVersionFileName, {encoding: 'utf8'}).then(contents => {
+        const matches = contents.trim().match(versionRegex);
+        const version = matches.groups.version;
+        if (!version) {
+          result.isSuccess = false;
+          result.reason = i18n.t('wkt-tools-wdt-version-file-format-error', { file: wdtVersionFileName });
+          return resolve(result);
+        }
+
+        if (compareVersions(version, minimumVersion) < 0) {
+          const wktApp = new WktApp(_wktMode);
+          result.isSuccess = false;
+          result.reason = i18n.t('wkt-tools-wdt-version-not-compatible-error',
+            { version: version, minimumVersion: minimumVersion, wktuiVersion: wktApp.getApplicationVersion() });
+        }
+        resolve(result);
+      }).catch(err => {
+        result.isSuccess = false;
+        result.reason = i18n.t('wkt-tools-wdt-version-file-read-error', { file: wdtVersionFileName, error: getErrorMessage(err) });
+        return resolve(result);
+      });
+    });
+  });
+}
+
 async function getWdtSupportedDomainTypes() {
   const typedefsDirectory = path.join(getWdtDirectory(), 'lib', 'typedefs');
   return new Promise((resolve, reject) => {
@@ -256,6 +289,52 @@ async function getOptions() {
   });
 }
 
+function compareVersions(version, minimumVersion) {
+  const versionComponents = version.split(/[.-]/);
+  const minimumVersionComponents = minimumVersion.split(/[.-]/);
+
+  // Fix up the minimum version components to have the correct number of places...
+  if (minimumVersionComponents.length !== 4) {
+    const len = minimumVersionComponents.length;
+    const isSnapshot = minimumVersionComponents[len - 1] === 'SNAPSHOT';
+    if (len !== 3 || isSnapshot) {
+      const missingDigits = isSnapshot ? 4 - len : 3 - len;
+      const insertPosition = isSnapshot ? len - 2 : len - 1;
+      for (let i = 0; i < missingDigits; i++) {
+        minimumVersionComponents.splice(insertPosition, 0, '0');
+      }
+    }
+  }
+
+  // Iterate over the version elements now that the minimum version elements is fully specified...
+  let result = 0;
+  for (let i = 0; i < 3; i++) {
+    const versionNumber = Number(versionComponents[i]);
+    const minVersionNumber = Number(minimumVersionComponents[i]);
+
+    if (versionNumber < minVersionNumber) {
+      result = -1;
+      break;
+    } else if (versionNumber > minVersionNumber) {
+      result = 1;
+      break;
+    }
+  }
+
+  if (result === 0) {
+    const versionIsSnapshot = versionComponents.length === 4;
+    const minimumVersionIsSnapshot = minimumVersionComponents.length === 4;
+    if (versionIsSnapshot && !minimumVersionIsSnapshot) {
+      result = -1;
+    } else if (!versionIsSnapshot && minimumVersionIsSnapshot) {
+      result = 1;
+    }
+  }
+
+  getLogger().debug('compareVersion(%s, %s) returned %d', version, minimumVersion, result);
+  return result;
+}
+
 module.exports = {
   checkForUpdates,
   downloadLatestWdtInstaller,
@@ -271,5 +350,6 @@ module.exports = {
   getWdtSupportedDomainTypes,
   initialize,
   isWdtErrorExitCode,
-  isWitErrorExitCode
+  isWitErrorExitCode,
+  isWdtVersionCompatible
 };

electron/app/locales/en/electron.json

@@ -208,7 +208,7 @@
   "wdt-discovery-non-zero-exit-code-error-message": "Discover domain script {{script}} exited with non-zero exit code: {{exitCode}}.",
   "wdt-discovery-failed-error-message": "Discover domain script {{script}} failed: {{error}};",
 
-  "validate-model-error-exit-code-error-message": "Validate Model script exited with {{exitCode}}, which indicates an error.",
+  "validate-model-error-exit-code-error-message": "Validate Model script exited with {{exitCode}}, which indicates an error",
   "validate-model-execution-failed-error-message": "Validate Model script failed: {{error}}",
 
   "prepare-model-unknown-target-type-error-message": "Unable to prepare model with unknown target type: {{wdtTargetType}}.",
@@ -351,6 +351,11 @@
   "wdt-archiveType-sharedLibraryDir": "Shared Library Directory",
   "wdt-archiveType-fileStore": "File Store Directory",
 
+  "wkt-tools-wdt-version-file-missing-error": "Unable to determine the version of WebLogic Deploy Tooling installed because the {{file}} file is not found",
+  "wkt-tools-wdt-version-file-read-error": "Unable to determine the version of WebLogic Deploy Tooling installed because an error occurred while reading the {{file}} file: {{error}}",
+  "wkt-tools-wdt-version-file-format-error": "Unable to determine the version of WebLogic Deploy Tooling installed because the {{file}} file is not in the expected format",
+  "wkt-tools-wdt-version-not-compatible-error": "The installed WebLogic Deploy Tooling version {{version}} does not meet the minimum compatible version {{minimumVersion}} required by WebLogic Kubernetes Toolkit UI version {{wktuiVersion}}",
+
   "project-save-file-already-open-title": "Project File Already Open",
   "project-save-file-already-open-message": "The project file {{projectFile}} is already open in another window.  Please either close the existing window or select a different project file and try again."
 }

tools/wdt-config/dii/targets/vz/target.json

@@ -8,6 +8,7 @@
   "variable_injectors" : {"PORT": {},"HOST": {},"URL": {}},
   "validation_method" : "lax",
   "credentials_output_method" : "script",
+  "exclude_domain_bin_contents": true,
   "wls_credentials_name" : "__weblogic-credentials__",
   "additional_secrets": "runtime-encryption-secret",
   "additional_output" : "vz-application.yaml"

tools/wdt-config/dii/targets/wko/target.json

@@ -8,6 +8,7 @@
   "variable_injectors" : {"PORT": {},"HOST": {},"URL": {}},
   "validation_method" : "wktui",
   "credentials_output_method" : "json",
+  "exclude_domain_bin_contents": true,
   "wls_credentials_name" : "__weblogic-credentials__",
   "additional_secrets": "runtime-encryption-secret",
   "additional_output" : "wko-domain.yaml"

tools/wdt-config/mii/targets/vz/target.json

@@ -9,6 +9,7 @@
   "validation_method" : "wktui",
   "credentials_method" : "secrets",
   "credentials_output_method" : "script",
+  "exclude_domain_bin_contents": true,
   "wls_credentials_name" : "__weblogic-credentials__",
   "additional_secrets": "runtime-encryption-secret",
   "additional_output" : "vz-application.yaml"

tools/wdt-config/mii/targets/wko/target.json

@@ -9,6 +9,7 @@
   "validation_method" : "wktui",
   "credentials_method" : "secrets",
   "credentials_output_method" : "json",
+  "exclude_domain_bin_contents": true,
   "wls_credentials_name" : "__weblogic-credentials__",
   "additional_secrets": "runtime-encryption-secret",
   "additional_output" : "wko-domain.yaml"