Added support for ltpa token

packages/sdk/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the IBM® CICS® Plug-in for Zowe CLI will be documented in this file.
 
+
+## Recent Changes
+
+- Enhancement: Use LTPA tokens to allow CMCI "sessions". [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)
+
 ## `6.3.3`
 
 - Enhancement: Add requestOptions to getResource and getCache method. [#220](https://github.com/zowe/cics-for-zowe-client/issues/220)

packages/sdk/src/constants/CicsCmci.constants.ts

@@ -18,6 +18,11 @@ export const CicsCmciConstants = {
      */
   CICS_SYSTEM_MANAGEMENT: "CICSSystemManagement",
 
+  /**
+     * Specifies the required part of the REST interface URI to access initialization parameter
+     */
+  CICS_SYSTEM_PARAMETER: "CICSSystemParameter",
+
   /**
      * Specifies the required part of the REST interface URI to access program definitions
      */
@@ -38,6 +43,11 @@ export const CicsCmciConstants = {
      */
   CICS_PROGRAM_RESOURCE: "CICSProgram",
 
+  /**
+     * Specifies the required part of the REST interface URI to access library resources
+     */
+  CICS_LIBRARY_RESOURCE: "CICSLibrary",
+
   /**
      * Specifies the required part of the REST interface URI to access URIMap definitions
      */
@@ -48,6 +58,11 @@ export const CicsCmciConstants = {
      */
   CICS_DEFINITION_WEBSERVICE: "CICSDefinitionWebService",
 
+  /**
+     * Specifies the required part of the REST interface URI to access tcp/ip service definitions
+     */
+  CICS_DEFINITION_TCPIPSERVICE: "CICSTCPIPService",
+
   /*
      * Specifies the required part of the REST interface URI to access URIMaps
      */

packages/vsce/CHANGELOG.md

@@ -4,9 +4,11 @@ All notable changes to the "cics-extension-for-zowe" extension will be documente
 
 ## Recent Changes
 
+- Enhancement:Use LTPA tokens to allow CMCI "sessions" [#217](https://github.com/zowe/cics-for-zowe-client/issues/217)
 - Enhancement: Create icons for library and Web resources. [#229](https://github.com/zowe/cics-for-zowe-client/issues/229)
 
 ## `3.3.3`
+
 - BugFix: Duplicate CICSplex exist when connecting to a multi-CMAS system. [#227](https://github.com/zowe/cics-for-zowe-client/issues/227)
 - Enhancement: Show CMCI error response codes when failing to make requests. [#220](https://github.com/zowe/cics-for-zowe-client/issues/220)
 

packages/vsce/__tests__/__unit__/trees/CICSRegionsContainer.unit.test.ts

@@ -87,7 +87,8 @@ describe("Test suite for CICSRegionsContainer", () => {
 
       await sut.loadRegionsInCICSGroup(CICSTreeMock as any as CICSTree);
 
-      expect(getResourceMock).toHaveBeenCalledWith(sut.getParent().getParent().getSession(), testData);
+      expect(getResourceMock).toHaveBeenCalledWith(sut.getParent().getParent().getSession(), testData,
+      { failOnNoData: false, useCICSCmciRestError: true });
       expect(sut.label).toBe("Regions (cics) [1/1]");
       expect(sut.collapsibleState).toBe(2);
     });
@@ -103,7 +104,7 @@ describe("Test suite for CICSRegionsContainer", () => {
 
     it("Should load all regions of plex", async () => {
       await sut.loadRegionsInPlex();
-      
+
       expect(getRegionInfoInPlexMock).toHaveBeenCalledTimes(1);
       expect(sut.label).toBe("Regions [2/2]");
       expect(sut.collapsibleState).toBe(2);

packages/vsce/__tests__/__unit__/trees/CICSSessionTree.unit.test.ts

@@ -16,62 +16,66 @@ import { CICSRegionTree } from "../../../src/trees/CICSRegionTree";
 import { CICSSessionTree } from "../../../src/trees/CICSSessionTree";
 import * as globalMocks from "../../__utils__/globalMocks";
 
+
 jest.mock("@zowe/zowe-explorer-api");
 jest.mock("../../../src/utils/iconUtils", () => {
   return { getIconFilePathFromName: getIconFilePathFromNameMock };
 });
-const cicsTreeMock = jest.fn();
+const cisutreeMock = jest.fn();
 const treeResourceMock = globalMocks.getDummyTreeResources("cicsmanagedregion", "fileName*");
 const profile = {
   profile: { user: "user", password: "pwd", hostname: "hostname", protocol: "https", type: "basic", rejectUnauthorized: false, port: 8080 },
 };
 describe("Test suite for CICSSessionTree", () => {
   let sut: CICSSessionTree;
 
-  beforeEach(() => {
-    getIconFilePathFromNameMock.mockReturnValue(treeResourceMock.iconPath);
+  describe("Validation", () => {
 
-    sut = new CICSSessionTree(profile);
-    sut.isUnauthorized = true;
-    expect(getIconFilePathFromNameMock).toHaveBeenCalledWith("profile-unverified");
-  });
+    beforeEach(() => {
+      getIconFilePathFromNameMock.mockReturnValue(treeResourceMock.iconPath);
 
-  afterEach(() => {
-    jest.resetAllMocks();
-  });
+      sut = new CICSSessionTree(profile);
+      sut.isUnauthorized = true;
+      expect(getIconFilePathFromNameMock).toHaveBeenCalledWith("profile-unverified");
+    });
 
-  describe("Test suite for addRegion", () => {
-    it("should push CICSRegionTree object into children", () => {
-      sut.addRegion(cicsTreeMock as any as CICSRegionTree);
-      expect(sut.getChildren().length).toBeGreaterThanOrEqual(1);
+    afterEach(() => {
+      jest.resetAllMocks();
     });
-  });
-  describe("Test suite for addPlex", () => {
-    it("should push CICSPlexTree object into children", () => {
-      sut.addPlex(cicsTreeMock as any as CICSPlexTree);
-      expect(sut.getChildren().length).toBeGreaterThanOrEqual(1);
+
+    describe("Test suite for addRegion", () => {
+      it("should push CICSRegionTree object into children", () => {
+        sut.addRegion(cisutreeMock as any as CICSRegionTree);
+        expect(sut.getChildren().length).toBeGreaterThanOrEqual(1);
+      });
     });
-  });
-  describe("Test suite for getChildren", () => {
-    it("should return an array of childrens", () => {
-      expect(sut.getChildren().length).toBeGreaterThanOrEqual(0);
+    describe("Test suite for addPlex", () => {
+      it("should push CICSPlexTree object into children", () => {
+        sut.addPlex(cisutreeMock as any as CICSPlexTree);
+        expect(sut.getChildren().length).toBeGreaterThanOrEqual(1);
+      });
     });
-  });
-  describe("Test suite for setUnauthorized", () => {
-    it("should set isUnauthorized to true", () => {
-      sut.setUnauthorized();
-      expect(sut.isUnauthorized).toBeTruthy();
+    describe("Test suite for getChildren", () => {
+      it("should return an array of childrens", () => {
+        expect(sut.getChildren().length).toBeGreaterThanOrEqual(0);
+      });
     });
-  });
-  describe("Test suite for setAuthorized", () => {
-    it("should set isUnauthorized to false", () => {
-      sut.setAuthorized();
-      expect(sut.isUnauthorized).toBeFalsy();
+    describe("Test suite for setUnauthorized", () => {
+      it("should set isUnauthorized to true", () => {
+        sut.setUnauthorized();
+        expect(sut.isUnauthorized).toBeTruthy();
+      });
     });
-  });
-  describe("Test suite for getIsUnauthorized", () => {
-    it("should return the object of isUnauthorized", () => {
-      expect(sut.getIsUnauthorized()).toBeTruthy();
+    describe("Test suite for setAuthorized", () => {
+      it("should set isUnauthorized to false", () => {
+        sut.setAuthorized();
+        expect(sut.isUnauthorized).toBeFalsy();
+      });
+    });
+    describe("Test suite for getIsUnauthorized", () => {
+      it("should return the object of isUnauthorized", () => {
+        expect(sut.getIsUnauthorized()).toBeTruthy();
+      });
     });
   });
 });

packages/vsce/__tests__/__unit__/trees/CICSSessionTreeLtpa.unit.test.ts

@@ -0,0 +1,90 @@
+/**
+ * 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.
+ *
+ */
+
+const getIconFilePathFromNameMock = jest.fn();
+
+import { imperative } from "@zowe/zowe-explorer-api";
+import { CICSSessionTree } from "../../../src/trees/CICSSessionTree";
+
+jest.mock("../../../src/utils/iconUtils", () => {
+  return { getIconFilePathFromName: getIconFilePathFromNameMock };
+});
+
+describe("Test suite for CICSSessionTree", () => {
+  let sut: CICSSessionTree;
+  let ses: imperative.Session;
+
+  const cicsProfileMock = {
+    failNotFound: false,
+    message: "",
+    name: "A NAME",
+    profile: {
+      host: "a.b.c.d",
+      port: 12345,
+      rejectUnauthorized: false,
+      protocol: "http",
+      user: "A USER",
+      password: "A PASSWORD",
+    },
+    type: "cics"
+  };
+
+  describe("cookies", () => {
+
+    beforeEach(() => {
+      sut = new CICSSessionTree(cicsProfileMock);
+    });
+
+    afterEach(() => {
+      jest.resetAllMocks();
+    });
+
+    it("Should not store invalid cookie", () => {
+      const cookie = {
+        Cookie: "blah=hello"
+      };
+
+      ses = sut.getSession();
+      ses.storeCookie(cookie);
+
+      expect(ses.ISession.tokenType).toEqual("LtpaToken2");
+      expect(ses.ISession.tokenValue).toBeUndefined();
+    });
+
+    it("Should store valid cookie", () => {
+      const cookies = {
+        Cookie: "LtpaToken2=testValue"
+      };
+
+      sut = new CICSSessionTree(cicsProfileMock);
+      ses = sut.getSession();
+
+      ses.storeCookie(cookies);
+
+      expect(ses.ISession.tokenType).toEqual("LtpaToken2");
+      expect(ses.ISession.tokenValue).toEqual("testValue");
+    });
+
+    it("Should store valid cookie if more the one returned", () => {
+      const cookies = {
+        Cookie: "blah=hello;LtpaToken2=testValue"
+      };
+
+      sut = new CICSSessionTree(cicsProfileMock);
+      ses = sut.getSession();
+
+      ses.storeCookie(cookies);
+
+      expect(ses.ISession.tokenType).toEqual("LtpaToken2");
+      expect(ses.ISession.tokenValue).toEqual("testValue");
+    });
+  });
+});

packages/vsce/src/commands/closeLocalFileCommand.ts

@@ -9,7 +9,7 @@
  *
  */
 
-import { CicsCmciConstants, CicsCmciRestClient, ICMCIApiResponse, Utils, IGetResourceUriOptions } from "@zowe/cics-for-zowe-sdk";
+import { CicsCmciConstants, ICMCIApiResponse } from "@zowe/cics-for-zowe-sdk";
 import { imperative } from "@zowe/zowe-explorer-api";
 import { commands, ProgressLocation, TreeView, window } from "vscode";
 import { CICSCombinedLocalFileTree } from "../trees/CICSCombinedTrees/CICSCombinedLocalFileTree";
@@ -19,6 +19,7 @@ import { CICSTree } from "../trees/CICSTree";
 import { CICSLocalFileTreeItem } from "../trees/treeItems/CICSLocalFileTreeItem";
 import { findSelectedNodes, splitCmciErrorMessage } from "../utils/commandUtils";
 import { ICommandParams } from "./ICommandParams";
+import { runPutResource } from "../utils/resourceUtils";
 import constants from "../utils/constants";
 
 export function getCloseLocalFileCommand(tree: CICSTree, treeview: TreeView<any>) {
@@ -116,12 +117,18 @@ export function getCloseLocalFileCommand(tree: CICSTree, treeview: TreeView<any>
   });
 }
 
-function closeLocalFile(
+async function closeLocalFile(
   session: imperative.AbstractSession,
   parms: ICommandParams,
   busyDecision: string
 ): Promise<ICMCIApiResponse> {
-  const requestBody: any = {
+  return runPutResource({
+    session: session,
+    resourceName: CicsCmciConstants.CICS_CMCI_LOCAL_FILE,
+    cicsPlex: parms.cicsPlex,
+    regionName: parms.regionName,
+    params: {"criteria": `FILE='${parms.name}'`}
+  }, {
     request: {
       action: {
         $: {
@@ -135,15 +142,5 @@ function closeLocalFile(
         },
       },
     },
-  };
-
-  const options: IGetResourceUriOptions = {
-    "cicsPlex": parms.cicsPlex,
-    "regionName": parms.regionName,
-    "criteria": `FILE='${parms.name}'`
-  };
-
-  const cmciResource = Utils.getResourceUri(CicsCmciConstants.CICS_CMCI_LOCAL_FILE, options);
-
-  return CicsCmciRestClient.putExpectParsedXml(session, cmciResource, [], requestBody);
+  });
 }

packages/vsce/src/commands/disableCommands/disableLocalFileCommand.ts

@@ -9,7 +9,7 @@
  *
  */
 
-import { CicsCmciConstants, CicsCmciRestClient, ICMCIApiResponse, Utils, IGetResourceUriOptions } from "@zowe/cics-for-zowe-sdk";
+import { CicsCmciConstants, ICMCIApiResponse } from "@zowe/cics-for-zowe-sdk";
 import { imperative } from "@zowe/zowe-explorer-api";
 import { commands, ProgressLocation, TreeView, window } from "vscode";
 import { CICSCombinedLocalFileTree } from "../../trees/CICSCombinedTrees/CICSCombinedLocalFileTree";
@@ -20,6 +20,7 @@ import { findSelectedNodes } from "../../utils/commandUtils";
 import { ICommandParams } from "../ICommandParams";
 import { CICSLocalFileTreeItem } from "../../trees/treeItems/CICSLocalFileTreeItem";
 import constants from "../../utils/constants";
+import { runPutResource } from "../../utils/resourceUtils";
 
 export function getDisableLocalFileCommand(tree: CICSTree, treeview: TreeView<any>) {
   return commands.registerCommand("cics-extension-for-zowe.disableLocalFile", async (clickedNode) => {
@@ -110,7 +111,13 @@ function disableLocalFile(
   parms: ICommandParams,
   busyDecision: string
 ): Promise<ICMCIApiResponse> {
-  const requestBody: any = {
+  return runPutResource({
+    session: session,
+    resourceName: CicsCmciConstants.CICS_CMCI_LOCAL_FILE,
+    cicsPlex: parms.cicsPlex,
+    regionName: parms.regionName,
+    params: {"criteria": `FILE='${parms.name}'`}
+  }, {
     request: {
       action: {
         $: {
@@ -123,16 +130,6 @@ function disableLocalFile(
           },
         },
       },
-    },
-  };
-
-  const options: IGetResourceUriOptions = {
-    "cicsPlex": parms.cicsPlex,
-    "regionName": parms.regionName,
-    "criteria": `FILE='${parms.name}'`
-  };
-
-  const cmciResource = Utils.getResourceUri(CicsCmciConstants.CICS_CMCI_LOCAL_FILE, options);
-
-  return CicsCmciRestClient.putExpectParsedXml(session, cmciResource, [], requestBody);
+    }
+  });
 }