Merge pull request #75 from oracle/mac-env-changes

Mac env changes

Author: robertpatrick

electron/app/js/imageBuilderUtils.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 fsUtils = require('./fsUtils');
@@ -36,18 +36,20 @@ async function validateImageBuilderExecutable(imageBuilderExe) {
   });
 }
 
-async function validateImageExistsLocally(imageBuilderExe, imageTag) {
+async function validateImageExistsLocally(imageBuilderOptions, imageTag) {
+  const imageBuilderExe = imageBuilderOptions.imageBuilderExe;
   const args = [
     'images',
     '-q',
     imageTag
   ];
+  const env = getDockerEnv(null, null, imageBuilderOptions);
   const result = {
     isSuccess: true,
     imageExists: true
   };
   return new Promise(resolve => {
-    executeFileCommand(imageBuilderExe, args).then(stdoutMessage => {
+    executeFileCommand(imageBuilderExe, args, env).then(stdoutMessage => {
       if (!/\S/.test(stdoutMessage.toString())) {
         result.imageExists = false;
       }
@@ -62,17 +64,18 @@ async function validateImageExistsLocally(imageBuilderExe, imageTag) {
   });
 }
 
-async function doLogin(imageBuilderExe, options) {
+async function doLogin(imageBuilderOptions, options) {
   const i18n = require('./i18next.config');
   const httpsProxyUrl = getHttpsProxyUrl();
   const bypassProxyHosts = getBypassProxyHosts();
+  const imageBuilderExe = imageBuilderOptions.imageBuilderExe;
 
   const result = { isSuccess: true };
   if (!options.requiresLogin) {
     return Promise.resolve({ isSuccess: true });
   }
 
-  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts);
+  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts, imageBuilderOptions);
   const args = [
     'login'
   ];
@@ -105,14 +108,15 @@ async function doLogin(imageBuilderExe, options) {
   });
 }
 
-async function doPushImage(currentWindow, stdoutChannel, stderrChannel, imageBuilderExe, imageTag, options) {
+async function doPushImage(currentWindow, stdoutChannel, stderrChannel, imageBuilderOptions, imageTag, options) {
   const i18n = require('./i18next.config');
   const httpsProxyUrl = getHttpsProxyUrl();
   const bypassProxyHosts = getBypassProxyHosts();
+  const imageBuilderExe = imageBuilderOptions.imageBuilderExe;
 
   const result = { isSuccess: true };
   if (options.requiresLogin) {
-    const loginResult = await doLogin(imageBuilderExe, options);
+    const loginResult = await doLogin(imageBuilderOptions, options);
     if (!loginResult.isSuccess) {
       result.isSuccess = false;
       result.reason = loginResult.reason;
@@ -121,7 +125,7 @@ async function doPushImage(currentWindow, stdoutChannel, stderrChannel, imageBui
   }
 
   const args = [ 'push', imageTag ];
-  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts);
+  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts, imageBuilderOptions);
 
   return new Promise(resolve => {
     executeChildProcess(currentWindow, imageBuilderExe, args, env, stdoutChannel,
@@ -139,11 +143,17 @@ async function doPushImage(currentWindow, stdoutChannel, stderrChannel, imageBui
   });
 }
 
-function getDockerEnv(httpsProxyUrl, bypassProxyHosts) {
+function getDockerEnv(httpsProxyUrl, bypassProxyHosts, imageBuilderOptions) {
+  let path = process.env.PATH;
+  if (imageBuilderOptions && imageBuilderOptions.extraPathDirectories) {
+    const extraPathDirectories = imageBuilderOptions.extraPathDirectories.join(path.delimiter);
+    path += `${path.delimiter}${extraPathDirectories}`;
+  }
+
   let env = {
     DOCKER_BUILDKIT: '0',
     // podman relies on the PATH including other executables (e.g., newuidmap)...
-    PATH: process.env.PATH
+    PATH: path
   };
 
   // Docker-specific environment variables that should be passed on
@@ -167,8 +177,18 @@ function getDockerEnv(httpsProxyUrl, bypassProxyHosts) {
   if (process.env.STORAGE_OPTS) {
     env['STORAGE_OPTS'] = process.env.STORAGE_OPTS;
   }
+  if (process.env.TMPDIR) {
+    env['TMPDIR'] = process.env.TMPDIR;
+  }
+
+  if (!osUtils.isWindows()) {
+    env['HOME'] = process.env.HOME;
+  } else {
+    env['USERPROFILE'] = process.env.USERPROFILE;
+    env['PROGRAMDATA'] = process.env.PROGRAMDATA;
+  }
 
-  // proxy-related environment variables
+  // Proxy-related environment variables
   if (httpsProxyUrl) {
     env['HTTPS_PROXY'] = httpsProxyUrl;
     env['https_proxy'] = httpsProxyUrl;
@@ -178,12 +198,12 @@ function getDockerEnv(httpsProxyUrl, bypassProxyHosts) {
     env['no_proxy'] = bypassProxyHosts;
   }
 
-  if (!osUtils.isWindows()) {
-    env['HOME'] = process.env.HOME;
-  } else {
-    env['USERPROFILE'] = process.env.USERPROFILE;
-    env['PROGRAMDATA'] = process.env.PROGRAMDATA;
+  if (imageBuilderOptions && imageBuilderOptions.extraEnvironmentVariables) {
+    const extraEnvironmentVariables =
+      osUtils.removeProtectedEnvironmentVariables(imageBuilderOptions.extraEnvironmentVariables);
+    env = Object.assign(env, extraEnvironmentVariables);
   }
+
   return env;
 }
 

electron/app/js/ipcRendererPreload.js

@@ -232,7 +232,9 @@ contextBridge.exposeInMainWorld(
       isLinux: () => osUtils.isLinux(),
       getApplicationName: () => wktApp.getApplicationName(),
       getVersion: () => wktApp.getApplicationVersion(),
-      getArgv: (name) => osUtils.getArgv(name)
+      getArgv: (name) => osUtils.getArgv(name),
+      getPathDirectories: () => osUtils.getPathDirectories(),
+      getEnvironmentVariables: () => osUtils.getEnvironmentVariables()
     },
     'i18n': {
       t: (keys, options) => {

electron/app/js/kubectlUtils.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';
@@ -602,7 +602,7 @@ async function apply(kubectlExe, fileData, options) {
 }
 
 function getKubectlEnvironment(options, httpsProxyUrl, bypassProxyHosts) {
-  const env = {
+  let env = {
     PATH: process.env.PATH
   };
   if (options) {
@@ -631,6 +631,12 @@ function getKubectlEnvironment(options, httpsProxyUrl, bypassProxyHosts) {
     env['USERPROFILE'] = process.env.USERPROFILE;
     env['PROGRAMDATA'] = process.env.PROGRAMDATA;
   }
+
+  if (options && options.extraEnvironmentVariables) {
+    const extraEnvironmentVariables =
+      osUtils.removeProtectedEnvironmentVariables(options.extraEnvironmentVariables);
+    env = Object.assign(env, extraEnvironmentVariables);
+  }
   return env;
 }
 

electron/app/js/osUtils.js

@@ -1,11 +1,13 @@
 /**
  * @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.
  */
 // Be careful what you put in terms of require statements in this file
 // since it is used during bootstrapping of the app.
 //
+const path = require('path');
+
 /* global process */
 function isWindows() {
   return process.platform === 'win32' || process.platform === 'cygwin' || process.platform === 'msys';
@@ -33,9 +35,47 @@ function getArgv(name) {
   return result;
 }
 
+function getPathDirectories() {
+  const result = [];
+  const pathEnvVar = process.env.PATH;
+  if (pathEnvVar) {
+    result.push(...pathEnvVar.split(path.delimiter));
+  }
+  return result;
+}
+
+function getEnvironmentVariables() {
+  return JSON.parse(JSON.stringify(process.env));
+}
+
+function removeProtectedEnvironmentVariables(extraEnvironmentVariablesObject) {
+  const envCopy = Object.assign({}, extraEnvironmentVariablesObject);
+
+  if ('PATH' in envCopy) {
+    delete envCopy['PATH'];
+  }
+  if ('HTTPS_PROXY' in envCopy) {
+    delete envCopy['HTTPS_PROXY'];
+  }
+  if ('https_proxy' in envCopy) {
+    delete envCopy['https_proxy'];
+  }
+  if ('NO_PROXY' in envCopy) {
+    delete envCopy['NO_PROXY'];
+  }
+  if ('no_proxy' in envCopy) {
+    delete envCopy['no_proxy'];
+  }
+  return envCopy;
+}
+
+
 module.exports = {
   getArgv,
+  getEnvironmentVariables,
+  getPathDirectories,
   isLinux,
   isMac,
-  isWindows
+  isWindows,
+  removeProtectedEnvironmentVariables
 };

electron/app/js/witCreate.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';
@@ -76,7 +76,7 @@ async function createAuxImage(currentWindow, stdoutChannel, stderrChannel, creat
 }
 
 function getCreateEnvironment(createConfig, httpsProxyUrl, bypassProxyHosts) {
-  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts);
+  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts, createConfig);
   env['JAVA_HOME'] = createConfig.javaHome;
   env['WLSIMG_BLDDIR'] = app.getPath('temp');
   return env;

electron/app/js/witInspect.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';
@@ -19,7 +19,7 @@ async function inspectImage(imageTag, options) {
     isSuccess: true
   };
   return new Promise(resolve => {
-    callImageToolInspect(options.javaHome, imageTag, { buildEngine: options.imageBuilder }).then(response => {
+    callImageToolInspect(options.javaHome, imageTag, options).then(response => {
       getLogger().debug('inspectResponse is a %s and equals: %s', typeof response, response);
       try {
         inspectResults['contents'] = JSON.parse(response);
@@ -57,16 +57,16 @@ function getInspectEnvironment(javaHome, options, httpsProxyUrl, bypassProxyHost
   if (options && 'useProxy' in options && options.useProxy && !httpsProxyUrl) {
     throw new Error('Image tool inspection called with useProxy option but user settings has no proxy URL set.');
   }
-  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts);
+  const env = getDockerEnv(httpsProxyUrl, bypassProxyHosts, options);
   env['JAVA_HOME'] = javaHome;
   env['WLSIMG_BLDDIR'] = app.getPath('temp');
   return env;
 }
 
 function getImageToolInspectArgs(imageTag, options) {
   const args = [ 'inspect', `--image=${imageTag}`, '--patches', '--format=JSON' ];
-  if ('buildEngine' in options && options.buildEngine) {
-    args.push(`--builder=${options['buildEngine']}`);
+  if ('imageBuilderExe' in options && options.imageBuilderExe) {
+    args.push(`--builder=${options['imageBuilderExe']}`);
   }
   return args;
 }

electron/app/locales/en/webui.json

@@ -40,10 +40,6 @@
   "kubectl-config-file-help": "The Kubernetes client configuration file(s) to use.  Leave this empty to use the default location.",
   "kubectl-config-context-label": "Kubectl Config Context to Use",
   "kubectl-config-context-help": "The Kubernetes config file context name for the cluster to which you want to connect.  The default is to use whatever the current context is, if any.",
-  "kubectl-add-row-icon-text": "Add Extra Kubernetes Client Path Directory",
-  "kubectl-choose-path-icon-text": "Choose Extra Kubernetes Client Path Directory",
-  "kubectl-delete-row-icon-text": "Remove Extra Kubernetes Client Path Directory",
-  "kubectl-extra-path-directory-header": "Extra Kubernetes Client Path Directories",
   "kubectl-helm-exe-file-path-label": "Helm Executable to Use",
   "kubectl-helm-exe-file-path-help": "The full path to the Helm executable that is used to install the WebLogic Kubernetes Operator and some ingress controllers in your Kubernetes cluster.",
   "kubectl-list-aksCompleteLabel": "Microsoft documentation",
@@ -66,8 +62,8 @@
   "kubectl-list-verifyInstall": "Open a command line and run {{command}} to verify the installation before proceeding.",
   "kubectl-list-versionSkew": "When installing kubectl, please install a version that is compatible with the target Kubernetes cluster. Please refer to the {{link}} for more information.",
   "kubectl-list-versionSkewLabel": "Kubernetes Version Skew Policy",
-  "kubectl-list-extraPathDirectories": "On MacOS, add the directory where the {{executable}} executable is installed to the Extra Kubernetes Client Path Directories list.",
-  "kubectl-list-eks-extraPathDirectories": "On MacOS, add the directory where the either the {{executable1}} or the {{executable2}} executable is installed to the Extra Kubernetes Client Path Directories list.",
+  "kubectl-list-extraPathDirectories": "On macOS, add the directory where the {{executable}} executable is installed to the Extra Path Directories list on the Project Settings page.",
+  "kubectl-list-eks-extraPathDirectories": "On macOS, add the directory where the either the {{executable1}} or the {{executable2}} executable is installed to the Extra Path Directories list on the Project Settings page.",
   "kubectl-button-verifyKubectlConnectivity": "Verify Connectivity",
   "kubectl-hints-verifyKubectlConnectivity": "Verify Kubernetes Client Connectivity to Cluster",
 
@@ -84,6 +80,20 @@
 
   "project-settings-form-name": "Project Settings",
   "project-settings-title": "Project Settings",
+  "project-settings-mac-environment-question": "For macOS, do you need to add directories to the PATH or define other environment variables for Docker/Podman or Kubernetes?",
+  "project-settings-add-path-row-icon-text": "Add Extra Path Directory",
+  "project-settings-choose-path-icon-text": "Choose Extra Path Directory",
+  "project-settings-delete-path-row-icon-text": "Remove Extra Path Directory",
+  "project-settings-extra-path-directory-header": "Extra Path Directories",
+  "project-settings-hints-macos-path-directories": "Show System Path Directories",
+  "project-settings-button-macos-path-directories": "Show System Path",
+  "project-settings-add-env-var-row-icon-text": "Add Extra Environment Variable",
+  "project-settings-delete-env-var-row-icon-text": "Remove Extra Environment Variable",
+  "project-settings-extra-environment-variable-name-header": "Extra Environment Variable Names",
+  "project-settings-extra-environment-variable-value-header": "Extra Environment Variable Values",
+  "project-settings-hints-macos-environment-variables": "Show System Environment Variables",
+  "project-settings-button-macos-environment-variables": "Show System Environment",
+  "project-settings-mac-environment-answer-message": "On macOS, applications started from the Launchpad, Dock, Finder, and Spotlight do not inherit the user's environment.  As such, this application may not have the environment necessary to invoke Docker/Podman, kubectl, and Helm.  Use this section to add extra directories to the PATH and define the extra environment variables needed.  Please note that this extra environment configuration is only used when invoking Docker/Podman, kubectl, and Helm.",
   "project-settings-domain-location-title": "Target Oracle Fusion Middleware Domain Location",
   "project-settings-domain-location-question": "Where would you like the target Oracle Fusion Middleware domain to live?",
   "project-settings-domain-location-help": "Where and when the Oracle Fusion Middleware domain will be created.",
@@ -133,6 +143,12 @@
   "project-settings-credential-store-none-label": "Not Stored",
   "project-settings-credential-store-policy-answer-message": "The Credential Store Policy controls how credentials are handled when the project is saved and loaded.  The options are to store them in the machine's native credential store, store them in the project file encrypted with a passphrase, or not store them at all.",
 
+  "macos-path-directories-dialog-title": "Inherited PATH Environment Variable Directories",
+
+  "macos-environment-variables-dialog-title": "Inherited Environment Variables",
+  "macos-environment-variables-dialog-name-header": "Name",
+  "macos-environment-variables-dialog-value-header": "Value",
+
   "user-settings-dialog-log-level-error": "Error",
   "user-settings-dialog-log-level-warn": "Warning",
   "user-settings-dialog-log-level-info": "Information",
@@ -816,7 +832,7 @@
   "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-validator-validate-complete-message": "Validate Model successfully validated 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.",
@@ -1278,7 +1294,7 @@
   "quickstart-page2-list-item-4": "Accessing Docker Hub, GitHub Container Registry, and any other remote Image registries the project specifies.",
   "quickstart-page2-list-item-5": "Accessing any remote Kubernetes cluster the project configuration specifies.",
   "quickstart-page2-paragraph-1": "As such, it is critical that you review the application preferences to make sure that the Proxy Configuration is correct for your environment.",
-  "quickstart-page2-paragraph-2": "To access the application preferences, use the Preferences menu item, which is located in the File menu on Windows and Linux and in the application menu on MacOS.",
+  "quickstart-page2-paragraph-2": "To access the application preferences, use the Preferences menu item, which is located in the File menu on Windows and Linux and in the application menu on macOS.",
   "quickstart-page2-paragraph-3": "Should you have to change the Proxy Configuration, restart the application to make sure the application provides you all the help possible for the default values.",
 
   "quickstart-page3-title": "WKT Project File",