Merge pull request #70 from oracle/validate-model

adding validate model files action for use with WDT 2.0 validateModel

Author: robertpatrick

electron/app/js/fsUtils.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 const fsPromises = require('fs/promises');
@@ -164,6 +164,20 @@ function getAbsolutePath(pathToCheck, baseDirectory) {
   return path.normalize(path.join(baseDirectory, pathToCheck));
 }
 
+function getAbsolutePathsList(pathsToCheckList, baseDirectory) {
+  const resultArray = [];
+  if (pathsToCheckList) {
+    for (const file of pathsToCheckList) {
+      if (path.isAbsolute(file)) {
+        resultArray.push(file);
+      } else {
+        resultArray.push(path.join(baseDirectory, file));
+      }
+    }
+  }
+  return resultArray;
+}
+
 // returns the relative path for childPath, only if it is below parentPath.
 // returns null for any other case.
 function getRelativePath(parentPath, childPath) {
@@ -300,6 +314,7 @@ async function _processDirectoryListing(directory, listing, fileList) {
 module.exports = {
   exists,
   getAbsolutePath,
+  getAbsolutePathsList,
   getRelativePath,
   getExecutableFilePath,
   getFilesRecursivelyFromDirectory,

electron/app/js/ipcRendererPreload.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 const { contextBridge, ipcRenderer } = require('electron');
@@ -64,6 +64,7 @@ contextBridge.exposeInMainWorld(
           'app-update-available',
           'blur-focused-item',
           'start-prepare-model',
+          'start-validate-model',
           'start-create-image',
           'start-create-aux-image',
           'start-push-image',
@@ -141,6 +142,7 @@ contextBridge.exposeInMainWorld(
           'show-error-message',
           'show-info-message',
           'prepare-model',
+          'validate-model',
           'verify-files-exist',
           'verify-file-exists',
           'ok-or-cancel-prompt',

electron/app/js/wdtPrepareModel.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 'use strict';
@@ -30,7 +30,7 @@ async function prepareModel(currentWindow, stdoutChannel, stderrChannel, prepare
   const logger = getLogger();
   const { javaHome, oracleHome, projectDirectory, modelsSubdirectory, modelFiles, variableFiles, wdtTargetType } = prepareConfig;
   const outputDirectory = await fsUtils.createTemporaryDirectory(projectDirectory, 'prepareModel');
-  const absoluteModelFiles = getAbsolutePathFileList(projectDirectory, modelFiles);
+  const absoluteModelFiles = fsUtils.getAbsolutePathsList(modelFiles, projectDirectory);
 
   const argList = [
     '-oracle_home', oracleHome,
@@ -39,7 +39,7 @@ async function prepareModel(currentWindow, stdoutChannel, stderrChannel, prepare
     '-target', wdtTargetType
   ];
 
-  const absoluteVariableFiles = getAbsolutePathFileList(projectDirectory, variableFiles);
+  const absoluteVariableFiles = fsUtils.getAbsolutePathsList(variableFiles, projectDirectory);
   if (absoluteVariableFiles.length > 0) {
     argList.push('-variable_file', absoluteVariableFiles.join(','));
   }
@@ -188,20 +188,6 @@ async function removeTempDirectory(outputDirectory) {
   });
 }
 
-function getAbsolutePathFileList(projectDirectory, fileList) {
-  const resultArray = [];
-  if (fileList) {
-    for (const file of fileList) {
-      if (path.isAbsolute(file)) {
-        resultArray.push(file);
-      } else {
-        resultArray.push(path.join(projectDirectory, file));
-      }
-    }
-  }
-  return resultArray;
-}
-
 async function moveModelFiles(projectDirectory, modelsSubdirectory, outputDirectory, modelFiles) {
   const updatedFileMap = new Map();
   for (const modelFile of modelFiles) {

electron/app/js/wdtValidateModel.js

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * Copyright (c) 2022, Oracle and/or its affiliates.
+ * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+const fsUtils = require('./fsUtils');
+const { getLogger } = require('./wktLogging');
+const { getWdtCustomConfigDirectory, getValidateModelShellScript, isWdtErrorExitCode} = require('./wktTools');
+const childProcessExecutor = require('./childProcessExecutor');
+const { getErrorMessage } = require('./errorUtils');
+
+const i18n = require('./i18next.config');
+
+async function validateModel(currentWindow, stdoutChannel, stderrChannel, validateConfig) {
+  const logger = getLogger();
+  const { javaHome, oracleHome, projectDirectory, modelFiles, variableFiles, archiveFiles } = validateConfig;
+
+  const argList = [
+    '-oracle_home', oracleHome,
+    '-target_mode', 'offline',
+    '-method', 'wktui'
+  ];
+
+  const absoluteModelFiles = fsUtils.getAbsolutePathsList(modelFiles, projectDirectory);
+  if (absoluteModelFiles.length > 0) {
+    argList.push('-model_file', absoluteModelFiles.join(','));
+  }
+
+  const absoluteVariableFiles = fsUtils.getAbsolutePathsList(variableFiles, projectDirectory);
+  if (absoluteVariableFiles.length > 0) {
+    argList.push('-variable_file', absoluteVariableFiles.join(','));
+  }
+
+  const absoluteArchiveFiles = fsUtils.getAbsolutePathsList(archiveFiles, projectDirectory);
+  if (absoluteArchiveFiles.length > 0) {
+    argList.push('-archive_file', absoluteArchiveFiles.join(','));
+  }
+
+  const env = {
+    JAVA_HOME: javaHome,
+    WDT_CUSTOM_CONFIG: getWdtCustomConfigDirectory(validateConfig)
+  };
+  getLogger().debug(`Invoking ${getValidateModelShellScript()} with args ${JSON.stringify(argList)} and environment ${JSON.stringify(env)}`);
+
+  const results = {
+    isSuccess: true
+  };
+  try {
+    const exitCode = await childProcessExecutor.executeChildShellScript(currentWindow, getValidateModelShellScript(),
+      argList, env, stdoutChannel, { stderrEventName: stderrChannel });
+
+    if (isWdtErrorExitCode(exitCode)) {
+      results.isSuccess = false;
+      results.reason = i18n.t('validate-model-error-exit-code-error-message', { exitCode: exitCode });
+      logger.error(results.reason);
+      return Promise.resolve(results);
+    }
+  } catch (err) {
+    results.isSuccess = false;
+    results.reason = i18n.t('validate-model-execution-failed-error-message', { error: getErrorMessage(err) });
+    results.error = err;
+    logger.error(results.reason);
+    return Promise.resolve(results);
+  }
+  return Promise.resolve(results);
+}
+
+module.exports = {
+  validateModel
+};

electron/app/js/wktTools.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 const { dialog } = require('electron');
@@ -47,8 +47,12 @@ function getPrepareModelShellScript() {
   return path.join(getWdtDirectory(), 'bin', 'prepareModel' + scriptExtension);
 }
 
-function getWdtCustomConfigDirectory(prepareConfig) {
-  const targetDomainLocation = prepareConfig.targetDomainLocation || 'mii';
+function getValidateModelShellScript() {
+  return path.join(getWdtDirectory(), 'bin', 'validateModel' + scriptExtension);
+}
+
+function getWdtCustomConfigDirectory(config) {
+  const targetDomainLocation = config.targetDomainLocation || 'mii';
   return path.join(getToolsDirectory(), 'wdt-config', targetDomainLocation);
 }
 
@@ -262,6 +266,7 @@ module.exports = {
   getInstalledWdtReleaseName,
   getInstalledWitReleaseName,
   getLatestWkoImageName,
+  getValidateModelShellScript,
   getWdtCustomConfigDirectory,
   getWdtSupportedDomainTypes,
   initialize,

electron/app/js/wktWindow.js

@@ -227,9 +227,23 @@ class WktAppMenu {
         id: 'go',
         label: `&${i18n.t('menu-go')}`,
         submenu: [
+          {
+            id: 'validateModel',
+            label: i18n.t('menu-go-validate-model'),
+            enabled: !this._hasOpenDialog,
+            click(item, focusedWindow) {
+              if (!focusedWindow) {
+                return dialog.showErrorBox(
+                  i18n.t('menu-go-validate-model-error-title'),
+                  i18n.t('menu-go-validate-model-error-message')
+                );
+              }
+              sendToWindow(focusedWindow,'start-validate-model');
+            }
+          },
           {
             id: 'prepareModel',
-            label: i18n.t('menu-go-prep-model-for-k8s'),
+            label: i18n.t('menu-go-prepare-model-for-k8s'),
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {

electron/app/locales/en/electron.json

@@ -27,7 +27,10 @@
   "menu-edit-selectAll": "Select All",
 
   "menu-go": "Go",
-  "menu-go-prep-model-for-k8s": "Prepare Model for Kubernetes",
+  "menu-go-validate-model": "Validate Model Files",
+  "menu-go-validate-model-error-title": "No Active Project Window",
+  "menu-go-validate-model-error-message": "Cannot run Validate Model since there is no active window, and therefore no project with a model to validate.",
+  "menu-go-prepare-model-for-k8s": "Prepare Model for Kubernetes",
   "menu-go-prepare-model-error-title": "No Active Project Window",
   "menu-go-prepare-model-error-message": "Cannot run Prepare Model since there is no active window, and therefore no project with a model to prepare.",
   "menu-go-create-image": "Create Primary Image",
@@ -205,6 +208,9 @@
   "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-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}}.",
   "prepare-model-empty-target-type-error-message": "Unable to prepare model with an unspecified target type.",
   "prepare-model-invalid-java-home-error-message": "Unable to prepare model with invalid Java Home directory: {{javaHome}}.",

electron/app/locales/en/webui.json

@@ -799,6 +799,22 @@
   "wdt-discoverer-offline-discovery-failed-error-prefix": "Unable to discover domain {{domainHome}} in offline mode",
   "wdt-discoverer-online-discovery-failed-error-prefix": "Unable to discover domain {{adminUrl}} in online mode",
 
+  "wdt-validator-aborted-error-title": "Validate Model Aborted",
+  "wdt-validator-domain-in-pv-message": "Validate Model has no meaning when the target domain location is an externally created Kubernetes persistent volume.",
+  "wdt-validator-invalid-java-home-error-prefix": "Unable to validate model due to the Java Home being invalid",
+  "wdt-validator-invalid-oracle-home-error-prefix": "Unable to validate model due to the Oracle Home being invalid",
+  "wdt-validator-project-not-saved-error-prefix": "Unable to validate model because project save failed",
+  "wdt-validator-no-model-to-use-message": "The project file {{projectFile}} has no model to validate.",
+  "wdt-validator-invalid-model-file-message": "The project file {{projectFile}} has references to one or more model files that do not exist: {{invalidFileList}}",
+  "wdt-validator-invalid-variable-file-message": "The project file {{projectFile}} has references to one or more model variable files that do not exist: {{invalidFileList}}",
+  "wdt-validator-invalid-archive-file-message": "The project file {{projectFile}} has references to one or more model archive files that do not exist: {{invalidFileList}}",
+  "wdt-validator-validate-in-progress": "Validating Model",
+  "wdt-validator-validate-failed-error-title": "Validate Model Failed",
+  "wdt-validator-validate-failed-error-message": "Validate Model failed: {{error}}.  See Console window output for more information.",
+  "wdt-validator-validate-catch-all-error-message": "Validate Model failed with an unexpected error: {{error}}",
+  "wdt-validator-validate-complete-title": "Validate Model Complete",
+  "wdt-validator-validate-complete-message": "Validate Model successfully prepared the model.",
+
   "wdt-preparer-aborted-error-title": "Prepare Model Aborted",
   "wdt-preparer-domain-in-pv-message": "Prepare Model has no meaning when the target domain location is an externally created Kubernetes persistent volume.",
   "wdt-preparer-invalid-java-home-error-prefix": "Unable to prepare model due to the Java Home being invalid",
@@ -943,6 +959,8 @@
   "aux-image-pusher-create-failed-title":"Push Image Failed",
   "aux-image-pusher-create-failed-error-message":"Unable to push image {{imageTag}}: {{error}}.",
 
+  "model-page-button-validateModel": "Validate Model",
+  "model-page-hints-validateModel": "Validate Model Files",
   "model-page-button-prepareModel": "Prepare Model",
   "model-page-hints-prepareModel": "Prepare Model for Kubernetes",
   "model-page-model-editor-contents": "Model Editor Contents",
@@ -1118,6 +1136,7 @@
   "flow-online-discover-model-name": "Discover Model Online",
   "flow-offline-discover-model-name": "Discover Model Offline",
   "flow-discover-domain-in-progress": "Discovering domain",
+  "flow-validate-model-name": "Validate Model",
   "flow-prepare-model-name": "Prepare Model",
   "flow-inspect-base-image-name": "Inspect Base Image",
   "flow-create-image-name": "Create Primary Image",

electron/app/main.js

@@ -629,6 +629,11 @@ class Main {
       return prepareModel(event.sender.getOwnerBrowserWindow(), WKT_CONSOLE_STDOUT_CHANNEL, WKT_CONSOLE_STDERR_CHANNEL, prepareConfig);
     });
 
+    ipcMain.handle('validate-model', async (event, validateConfig) => {
+      const { validateModel } = require('./js/wdtValidateModel');
+      return validateModel(event.sender.getOwnerBrowserWindow(), WKT_CONSOLE_STDOUT_CHANNEL, WKT_CONSOLE_STDERR_CHANNEL, validateConfig);
+    });
+
     ipcMain.handle('verify-files-exist', async (event, baseDirectory, ...files) => {
       this._logger.debug(...files);
       return fsUtils.verifyFilesExist(baseDirectory, ...files);

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

@@ -1,7 +1,8 @@
 {
   "model_filters" : {
     "discover": [
-      { "name": "vz_prep", "path": "@@TARGET_CONFIG_DIR@@/vz_filter.py" }
+      { "name": "vz_prep", "path": "@@TARGET_CONFIG_DIR@@/vz_filter.py" },
+      { "id": "wko_filter" }
     ]
   },
   "variable_injectors" : {"PORT": {},"HOST": {},"URL": {}},