VSC Proxy Support

packages/zowe-explorer-api/__tests__/__unit__/profiles/__snapshots__/ZoweExplorerZosmfApi.unit.test.ts.snap

@@ -1,5 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`ZosmfUssApi constants should be unchanged 1`] = `"zosmf"`;
+exports[`ZosmfUssApi misc constants should be unchanged 1`] = `"zosmf"`;
 
-exports[`ZosmfUssApi constants should be unchanged 2`] = `"apimlAuthenticationToken"`;
+exports[`ZosmfUssApi misc constants should be unchanged 2`] = `"apimlAuthenticationToken"`;

packages/zowe-explorer-api/src/profiles/ProfilesCache.ts

@@ -17,6 +17,7 @@
 import { ZosTsoProfile } from "@zowe/zos-tso-for-zowe-sdk";
 import { ZosUssProfile } from "@zowe/zos-uss-for-zowe-sdk";
 import { Types } from "../Types";
+import { VscSettings } from "../vscode/doc/VscSettings";
 
 export class ProfilesCache {
     public profilesForValidation: Validation.IValidationProfile[] = [];
@@ -387,6 +388,13 @@
         return convertResult;
     }
 
+    public static getProfileSessionWithVscProxy(session: imperative.Session): imperative.Session {
+        const VsCodeProxySettings = VscSettings.getVsCodeProxySettings();
+        // will be able to uncomment following line and assign with CLI udpates
+        // session.ISession.proxy = VsCodeProxySettings;
+        return session;
+    }
+
     protected getCoreProfileTypes(): imperative.IProfileTypeConfiguration[] {
         return [ZosmfProfile, ZosTsoProfile, ZosUssProfile];
     }

packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts

@@ -20,6 +20,7 @@ import * as zosmf from "@zowe/zosmf-for-zowe-sdk";
 import { MainframeInteraction } from "../extend/MainframeInteraction";
 import { FileManagement } from "../utils";
 import { Types } from "../Types";
+import { ProfilesCache } from "../profiles/ProfilesCache";
 
 /**
  * Implementations of Zowe Explorer API for z/OSMF profiles
@@ -44,7 +45,10 @@ export namespace ZoweExplorerZosmf {
             const sessCfg = zosmf.ZosmfSession.createSessCfgFromArgs(cmdArgs);
             imperative.ConnectionPropsForSessCfg.resolveSessCfgProps(sessCfg, cmdArgs);
             const sessionToUse = new imperative.Session(sessCfg);
-            return sessionToUse;
+            // const VsCodeProxySettings = VscSettings.getVsCodeProxySettings();
+            // will be able to uncomment following line and assign with CLI udpates
+            // sessionToUse.ISession.proxy = VsCodeProxySettings;
+            return ProfilesCache.getProfileSessionWithVscProxy(sessionToUse);
         }
 
         public getSession(profile?: imperative.IProfileLoaded): imperative.Session {
@@ -56,7 +60,10 @@ export namespace ZoweExplorerZosmf {
                     imperative.Logger.getAppLogger().error(error as string);
                 }
             }
-            return this.session;
+            // const VsCodeProxySettings = VscSettings.getVsCodeProxySettings();
+            // will be able to uncomment following line and assign with CLI udpates
+            // this.session.ISession.proxy = VsCodeProxySettings;
+            return ProfilesCache.getProfileSessionWithVscProxy(this.session);
         }
 
         private _getSession(serviceProfile: imperative.IProfileLoaded): imperative.Session {

packages/zowe-explorer-api/src/vscode/ZoweVsCodeExtension.ts

@@ -11,13 +11,13 @@
 
 import * as semver from "semver";
 import * as vscode from "vscode";
-import { ProfilesCache } from "../profiles";
+import { ProfilesCache } from "../profiles/ProfilesCache";
 import { Login, Logout } from "@zowe/core-for-zowe-sdk";
 import * as imperative from "@zowe/imperative";
 import { Gui } from "../globals/Gui";
 import { PromptCredentialsOptions } from "./doc/PromptCredentials";
 import { Types } from "../Types";
-import { BaseProfileAuthOptions } from "./doc";
+import { BaseProfileAuthOptions } from "./doc/BaseProfileAuth";
 
 /**
  * Collection of utility functions for writing Zowe Explorer VS Code extensions.

packages/zowe-explorer-api/src/vscode/doc/VscSettings.ts

@@ -0,0 +1,46 @@
+/**
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+
+import * as vscode from "vscode";
+
+export class VscSettings {
+    /**
+     * Retrieves a generic setting either in user or workspace.
+     * @param {string} key - The config property that needs retrieving
+     * @param {T} defaultValue - Default value if config property is undefined
+     */
+    public static getDirectValue<T>(key: string, defaultValue?: T): T {
+        const [first, ...rest] = key.split(".");
+        return vscode.workspace.getConfiguration(first).get(rest.join("."), defaultValue);
+    }
+
+    // create mock ProxyVariables, able to remove after CLI changes adopted
+    public static proxyVars: {
+        http_proxy: string;
+        https_proxy: string;
+        no_proxy: string[];
+        proxy_authorization: string;
+        proxy_strict_ssl: boolean;
+    };
+    // Return will be Promise<imperative.ProxyVariables>
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    public static getVsCodeProxySettings() {
+        const proxySupport = this.getDirectValue("http.proxySupport");
+        if (proxySupport !== "on") {
+            return;
+        }
+        this.proxyVars.no_proxy = this.getDirectValue("http.noProxy");
+        this.proxyVars.proxy_strict_ssl = this.getDirectValue("http.proxyStrictSSL");
+        this.proxyVars.proxy_authorization = this.getDirectValue("http.proxyAuthorization");
+        this.proxyVars.http_proxy = this.proxyVars.https_proxy = this.getDirectValue("http.proxy");
+        return this.proxyVars;
+    }
+}

packages/zowe-explorer/__tests__/__unit__/configuration/Profiles.unit.test.ts

@@ -28,7 +28,17 @@ import {
 } from "../../__mocks__/mockCreators/shared";
 import { createDatasetSessionNode, createDatasetTree } from "../../__mocks__/mockCreators/datasets";
 import { createProfileManager } from "../../__mocks__/mockCreators/profiles";
-import { imperative, Gui, ZoweTreeNode, ZoweVsCodeExtension, IZoweTree, IZoweTreeNode, Validation, FileManagement } from "@zowe/zowe-explorer-api";
+import {
+    imperative,
+    Gui,
+    ZoweTreeNode,
+    ZoweVsCodeExtension,
+    IZoweTree,
+    IZoweTreeNode,
+    Validation,
+    FileManagement,
+    ProfilesCache,
+} from "@zowe/zowe-explorer-api";
 import { Profiles } from "../../../src/configuration/Profiles";
 import { ZoweExplorerExtender } from "../../../src/extending/ZoweExplorerExtender";
 import { ZoweExplorerApiRegister } from "../../../src/extending/ZoweExplorerApiRegister";
@@ -196,6 +206,10 @@ function createGlobalMocks(): { [key: string]: any } {
         }),
         configurable: true,
     });
+    Object.defineProperty(ProfilesCache, "getProfileSessionWithVscProxy", {
+        value: jest.fn().mockReturnValue(newMocks.testSession),
+        configurable: true,
+    });
 
     newMocks.testUSSTree = createUSSTree(undefined as any, [createUSSNode(newMocks.testSession, newMocks.testProfile)], createTreeView());
 

packages/zowe-explorer/__tests__/__unit__/trees/dataset/DatasetActions.unit.test.ts

@@ -11,7 +11,7 @@
 
 import * as vscode from "vscode";
 import * as zosfiles from "@zowe/zos-files-for-zowe-sdk";
-import { Gui, imperative, Validation, Types } from "@zowe/zowe-explorer-api";
+import { Gui, imperative, Validation, Types, ProfilesCache } from "@zowe/zowe-explorer-api";
 import { DatasetFSProvider } from "../../../../src/trees/dataset/DatasetFSProvider";
 import { bindMvsApi, createMvsApi } from "../../../__mocks__/mockCreators/api";
 import {
@@ -132,6 +132,7 @@ const createBlockMocksShared = () => {
     const testDatasetTree = createDatasetTree(datasetSessionNode, treeView);
     const mvsApi = createMvsApi(imperativeProfile);
     const fetchDsAtUri = jest.spyOn(DatasetFSProvider.instance, "fetchDatasetAtUri").mockImplementation();
+    Object.defineProperty(ProfilesCache, "getProfileSessionWithVscProxy", { value: jest.fn().mockReturnValue(zosmfSession), configurable: true });
     bindMvsApi(mvsApi);
 
     return {

packages/zowe-explorer/__tests__/__unit__/trees/dataset/DatasetTree.unit.test.ts

@@ -171,6 +171,7 @@ function createGlobalMocks() {
     Object.defineProperty(ZoweLogger, "warn", { value: jest.fn(), configurable: true });
     Object.defineProperty(ZoweLogger, "info", { value: jest.fn(), configurable: true });
     Object.defineProperty(ZoweLogger, "trace", { value: jest.fn(), configurable: true });
+    Object.defineProperty(ProfilesCache, "getProfileSessionWithVscProxy", { value: jest.fn().mockReturnValue(createISession()), configurable: true });
 
     return globalMocks;
 }