[WIP] force user to select kube config when there are multiple

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

src/explorer.ts

@@ -24,41 +24,12 @@ import {
 import * as Helm from './helm/helm';
 import { Oc } from './oc/ocWrapper';
 import { Odo } from './odo/odoWrapper';
-import { KubeConfigUtils } from './util/kubeUtils';
+import { KubeConfigUtils, getKubeConfigFiles } from './util/kubeUtils';
 import { Platform } from './util/platform';
 import { Progress } from './util/progress';
 import { FileContentChangeNotifier, WatchUtil } from './util/watch';
 import { vsCommand } from './vscommand';
 
-/**
- * Returns the list of kube config files:
- * - If KUBECONFIG is not set, just ~/.kube/config
- * - If KUBECONFIG is set, follows the semantics for specifying multiple config files described here:
- *   https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/#append-home-kube-config-to-your-kubeconfig-environment-variable
- *   BUT: it shows an error if multiple configs are specified, since the Kubernetes client we are using doesn't support this use case.
- */
-function getKubeConfigFiles(): string[] {
-    if (process.env.KUBECONFIG) {
-        let configuredFiles: string[] = [];
-        if (process.platform === 'win32') {
-            configuredFiles = process.env.KUBECONFIG.split(';');
-        } else {
-            configuredFiles = process.env.KUBECONFIG.split(':');
-        }
-        if (configuredFiles.length > 1) {
-            void window.showWarningMessage('KUBECONFIG specifies multiple files. Unfortunately, the extension doesn\'t work properly with this setup. Expect things to break.');
-        }
-        const filesThatExist: string[] = [];
-        for (const configFile of configuredFiles) {
-            if (fs.existsSync(configFile)) {
-                filesThatExist.push(configFile);
-            }
-        }
-        return filesThatExist;
-    }
-    return [path.join(Platform.getUserHomePath(), '.kube', 'config')];
-}
-
 type ExplorerItem = KubernetesObject | Helm.HelmRelease | Context | TreeItem;
 
 type PackageJSON = {

src/extension.ts

@@ -25,6 +25,7 @@ import { ServerlessFunctionView } from './serverlessFunction/view';
 import { startTelemetry } from './telemetry';
 import { ToolsConfig } from './tools';
 import { TokenStore } from './util/credentialManager';
+import { setKubeConfig } from './util/kubeUtils';
 import { Platform } from './util/platform';
 import { setupWorkspaceDevfileContext } from './util/workspace';
 import { registerCommands } from './vscommand';
@@ -71,6 +72,10 @@ export async function activate(extensionContext: ExtensionContext): Promise<unkn
     migrateFromOdo018();
     Cluster.extensionContext = extensionContext;
     TokenStore.extensionContext = extensionContext;
+
+    // pick kube config in case multiple are configured
+    await setKubeConfig();
+
     const crcStatusItem = window.createStatusBarItem(StatusBarAlignment.Left);
     crcStatusItem.command = 'openshift.explorer.stopCluster';
     const disposable = [

src/openshift/cluster.ts

@@ -7,6 +7,7 @@ import { KubernetesObject } from '@kubernetes/client-node';
 import { ExtensionContext, InputBox, QuickInputButton, QuickInputButtons, QuickPickItem, QuickPickItemButtonEvent, ThemeIcon, Uri, commands, env, window, workspace } from 'vscode';
 import { CommandText } from '../base/command';
 import { CliChannel } from '../cli';
+import { OpenShiftExplorer } from '../explorer';
 import { Oc } from '../oc/ocWrapper';
 import { Command } from '../odo/command';
 import { Odo } from '../odo/odoWrapper';
@@ -48,7 +49,7 @@ export class Cluster extends OpenShiftItem {
                     ),
                 )
                 .then(async () => {
-                    Cluster.explorer.refresh();
+                    OpenShiftExplorer.getInstance().refresh();
                     Cluster.serverlessView.refresh();
                     void commands.executeCommand('setContext', 'isLoggedIn', false);
                     const logoutInfo = await window.showInformationMessage(
@@ -67,7 +68,7 @@ export class Cluster extends OpenShiftItem {
 
     @vsCommand('openshift.explorer.refresh')
     static refresh(): void {
-        Cluster.explorer.refresh();
+        OpenShiftExplorer.getInstance().refresh();
         Cluster.serverlessView.refresh();
     }
 
@@ -806,7 +807,7 @@ export class Cluster extends OpenShiftItem {
     }
 
     static async loginMessage(clusterURL: string): Promise<string> {
-        Cluster.explorer.refresh();
+        OpenShiftExplorer.getInstance().refresh();
         Cluster.serverlessView.refresh();
         await commands.executeCommand('setContext', 'isLoggedIn', true);
         return `Successfully logged in to '${clusterURL}'`;

src/openshift/openshiftItem.ts

@@ -4,7 +4,6 @@
  *-----------------------------------------------------------------------------------------------*/
 
 import { commands, QuickPickItem, window } from 'vscode';
-import { OpenShiftExplorer } from '../explorer';
 import { Oc } from '../oc/ocWrapper';
 import { Odo } from '../odo/odoWrapper';
 import { Project } from '../odo/project';
@@ -26,8 +25,6 @@ export class QuickPickCommand implements QuickPickItem {
 export default class OpenShiftItem {
     protected static readonly odo = Odo.Instance;
 
-    protected static readonly explorer: OpenShiftExplorer = OpenShiftExplorer.getInstance();
-
     protected static readonly serverlessView: ServerlessFunctionView = ServerlessFunctionView.getInstance();
 
     static async getName(message: string, offset?: string, defaultValue = ''): Promise<string> {

src/openshift/project.ts

@@ -37,7 +37,7 @@ export class Project extends OpenShiftItem {
         } else {
             const projectName = selectedItem.label;
             await Odo.Instance.setProject(projectName);
-            Project.explorer.refresh();
+            OpenShiftExplorer.getInstance().refresh();
             Project.serverlessView.refresh();
             message = `Project '${projectName}' set as active.`;
         }

src/util/kubeUtils.ts

@@ -7,7 +7,8 @@ import { KubeConfig, findHomeDir, loadYaml } from '@kubernetes/client-node';
 import { Cluster, User } from '@kubernetes/client-node/dist/config_types';
 import * as fs from 'fs';
 import * as path from 'path';
-import { QuickPickItem } from 'vscode';
+import { QuickPickItem, window } from 'vscode';
+import { Platform } from './platform';
 
 function fileExists(file: string): boolean {
     try {
@@ -102,3 +103,50 @@ export class KubeConfigUtils extends KubeConfig {
     }
 
 }
+
+/**
+ * Returns the list of kube config files:
+ * - If KUBECONFIG is not set, just ~/.kube/config
+ * - If KUBECONFIG is set, follows the semantics for specifying multiple config files described here:
+ *   https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/#append-home-kube-config-to-your-kubeconfig-environment-variable
+ *   BUT: it shows an error if multiple configs are specified, since the Kubernetes client we are using doesn't support this use case.
+ */
+export function getKubeConfigFiles(): string[] {
+    if (process.env.KUBECONFIG) {
+        let configuredFiles: string[] = [];
+        if (process.platform === 'win32') {
+            configuredFiles = process.env.KUBECONFIG.split(';');
+        } else {
+            configuredFiles = process.env.KUBECONFIG.split(':');
+        }
+        const filesThatExist: string[] = [];
+        for (const configFile of configuredFiles) {
+            if (fs.existsSync(configFile)) {
+                filesThatExist.push(configFile);
+            }
+        }
+        return filesThatExist;
+    }
+    return [path.join(Platform.getUserHomePath(), '.kube', 'config')];
+}
+
+/**
+ * If there are multiple kube config files set, force the user to pick one to use.
+ */
+export async function setKubeConfig() {
+    const kubeConfigFiles = getKubeConfigFiles();
+    if (kubeConfigFiles.length > 1) {
+        let selectedFile;
+        while(!selectedFile) {
+            try {
+                const potentialSelection = await window.showQuickPick(kubeConfigFiles, { canPickMany: false, placeHolder: 'VSCode OpenShift only supports using one kube config. Please select which one to use.' });
+                if (potentialSelection) {
+                    selectedFile = potentialSelection;
+                }
+            } catch (_) {
+                // do nothing
+            }
+        }
+        process.env.KUBECONFIG = selectedFile;
+    }
+}