Support all DOCKER_* environment variables as VS Code settings

gulpfile.ts

@@ -15,6 +15,7 @@ const env = process.env;
 function test(): cp.ChildProcess {
     env.DEBUGTELEMETRY = '1';
     env.CODE_TESTS_WORKSPACE = path.join(__dirname, 'test/test.code-workspace');
+    env.MOCHA_timeout = String(10 * 1000);
     env.CODE_TESTS_PATH = path.join(__dirname, 'dist/test');
     return spawn('node', ['./node_modules/vscode/bin/test'], { stdio: 'inherit', env });
 }

package.json

@@ -988,7 +988,22 @@
                 "docker.host": {
                     "type": "string",
                     "default": "",
-                    "description": "Full host address to connect to (with protocol). Equivalent to setting the DOCKER_HOST environment variable"
+                    "description": "Equivalent to setting the DOCKER_HOST environment variable."
+                },
+                "docker.certPath": {
+                    "type": "string",
+                    "default": "",
+                    "description": "Equivalent to setting the DOCKER_CERT_PATH environment variable."
+                },
+                "docker.tlsVerify": {
+                    "type": "string",
+                    "default": "",
+                    "description": "Equivalent to setting the DOCKER_TLS_VERIFY environment variable."
+                },
+                "docker.machineName": {
+                    "type": "string",
+                    "default": "",
+                    "description": "Equivalent to setting the DOCKER_MACHINE_NAME environment variable."
                 },
                 "docker.importCertificates": {
                     "oneOf": [

src/extension.ts

@@ -25,6 +25,7 @@ import { DockerComposeParser } from './dockerCompose/dockerComposeParser';
 import { DockerfileCompletionItemProvider } from './dockerfileCompletionItemProvider';
 import { ext } from './extensionVariables';
 import { registerTrees } from './tree/registerTrees';
+import { addDockerSettingsToEnv } from './utils/addDockerSettingsToEnv';
 import { addUserAgent } from './utils/addUserAgent';
 import { getTrustedCertificates } from './utils/getTrustedCertificates';
 import { Keytar } from './utils/keytar';
@@ -269,32 +270,21 @@ function activateLanguageClient(): void {
     });
 }
 
+/**
+ * Dockerode parses and handles the well-known `DOCKER_*` environment variables, but it doesn't let us pass those values as-is to the constructor
+ * Thus we will temporarily update `process.env` and pass nothing to the constructor
+ */
 function refreshDockerode(): void {
-    const value: string = vscode.workspace.getConfiguration("docker").get("host", "");
-    if (value) {
-        let newHost: string = '';
-        let newPort: number = 2375;
-        let sep: number = -1;
-
-        sep = value.lastIndexOf(':');
-
-        const errorMessage = 'The docker.host configuration setting must be entered as <host>:<port>, e.g. dockerhost:2375';
-        if (sep < 0) {
-            vscode.window.showErrorMessage(errorMessage);
-        } else {
-            newHost = value.slice(0, sep);
-            newPort = Number(value.slice(sep + 1));
-            if (isNaN(newPort)) {
-                vscode.window.showErrorMessage(errorMessage);
-            } else {
-                ext.dockerode = new Dockerode({ host: newHost, port: newPort });
-            }
-        }
-    }
-
-    if (!ext.dockerode || !value) {
-        // Pass no options so that the defaultOpts of docker-modem will be used if the endpoint wasn't created
-        // or the user went from configured setting to empty settign
+    const oldEnv = process.env;
+    try {
+        process.env = { ...process.env }; // make a clone before we change anything
+        addDockerSettingsToEnv(process.env, oldEnv);
+        ext.dockerodeInitError = undefined;
         ext.dockerode = new Dockerode();
+    } catch (error) {
+        // This will be displayed in the tree
+        ext.dockerodeInitError = error;
+    } finally {
+        process.env = oldEnv;
     }
 }

src/extensionVariables.ts

@@ -31,6 +31,7 @@ export namespace ext {
     export let terminalProvider: ITerminalProvider;
     export let keytar: IKeytar | undefined;
     export let dockerode: Dockerode;
+    export let dockerodeInitError: unknown;
 
     export let imagesTree: AzExtTreeDataProvider;
     export let imagesTreeView: TreeView<AzExtTreeItem>;

src/tree/LocalRootTreeItemBase.ts

@@ -6,6 +6,7 @@
 import { ConfigurationChangeEvent, ConfigurationTarget, TreeView, TreeViewVisibilityChangeEvent, workspace, WorkspaceConfiguration } from "vscode";
 import { AzExtParentTreeItem, AzExtTreeItem, AzureWizard, GenericTreeItem, IActionContext, InvalidTreeItem, registerEvent } from "vscode-azureextensionui";
 import { configPrefix } from "../constants";
+import { ext } from "../extensionVariables";
 import { nonNullProp } from "../utils/nonNull";
 import { isLinux } from "../utils/osUtils";
 import { getThemedIconPath } from "./IconPath";
@@ -293,8 +294,12 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
     }
 
     private async getSortedItems(): Promise<TItem[]> {
-        const items: TItem[] = await this.getItems() || [];
-        return items.sort((a, b) => a.treeId.localeCompare(b.treeId));
+        if (ext.dockerodeInitError === undefined) {
+            const items: TItem[] = await this.getItems() || [];
+            return items.sort((a, b) => a.treeId.localeCompare(b.treeId));
+        } else {
+            throw ext.dockerodeInitError;
+        }
     }
 
     private async hasChanged(): Promise<boolean> {

src/utils/TerminalProvider.ts

@@ -5,6 +5,7 @@
 
 import * as vscode from 'vscode';
 import { Terminal } from 'vscode';
+import { addDockerSettingsToEnv } from './addDockerSettingsToEnv';
 
 export interface ITerminalProvider {
   createTerminal(name: string): Terminal;
@@ -14,12 +15,8 @@ export class DefaultTerminalProvider {
   public createTerminal(name: string): Terminal {
     let terminalOptions: vscode.TerminalOptions = {};
     terminalOptions.name = name;
-    const value: string = vscode.workspace.getConfiguration("docker").get("host", "");
-    if (value) {
-      terminalOptions.env = {
-        DOCKER_HOST: value
-      };
-    }
+    terminalOptions.env = {};
+    addDockerSettingsToEnv(terminalOptions.env, process.env);
     return vscode.window.createTerminal(terminalOptions);
   }
 }

src/utils/addDockerSettingsToEnv.ts

@@ -0,0 +1,32 @@
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { workspace } from 'vscode';
+import { configPrefix } from '../constants';
+import { ext } from '../extensionVariables';
+
+export function addDockerSettingsToEnv(env: {}, oldEnv: {}): void {
+    addDockerSettingToEnv("host", 'DOCKER_HOST', env, oldEnv);
+    addDockerSettingToEnv("certPath", 'DOCKER_CERT_PATH', env, oldEnv);
+    addDockerSettingToEnv("tlsVerify", 'DOCKER_TLS_VERIFY', env, oldEnv);
+    addDockerSettingToEnv("machineName", 'DOCKER_MACHINE_NAME', env, oldEnv);
+}
+
+function addDockerSettingToEnv(settingKey: string, envVar: string, env: {}, oldEnv: {}): void {
+    const value = workspace.getConfiguration(configPrefix).get<string>(settingKey, '');
+
+    const expectedType = "string";
+    const actualType = typeof value;
+    if (expectedType !== actualType) {
+        ext.outputChannel.appendLine(`WARNING: Ignoring setting "${configPrefix}.${settingKey}" because type "${actualType}" does not match expected type "${expectedType}".`);
+    } else if (value) {
+        if (oldEnv[envVar] && oldEnv[envVar] !== value) {
+            ext.outputChannel.appendLine(`WARNING: Overwriting environment variable "${envVar}" with VS Code setting "${configPrefix}.${settingKey}".`);
+        }
+
+        env[envVar] = value;
+    }
+}