[v3] Plugin registry field

packages/imperative/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Resolved bug that resulted in each plugin to have identical public registries regardless of actual installation location/reference
+- BugFix: Resolved bug that resulted in every plugin to have the same registry as the first if multiple were installed in the same command
+
 ## `8.0.0-next.202407021516`
 
 - BugFix: Updated dependencies for technical currency [#2188](https://github.com/zowe/zowe-cli/pull/2188)
+
 - Update: See `5.25.0` for details
 
 ## `8.0.0-next.202406201950`

packages/imperative/src/imperative/__tests__/plugins/PluginManagementFacility.unit.test.ts

@@ -234,8 +234,8 @@ describe("Plugin Management Facility", () => {
         const knownOverridePluginNm = CredentialManagerOverride.getKnownCredMgrs()[1].credMgrPluginName as string;
 
         const mockInstalledPlugins: IPluginJson = {
-            firstPlugin: {package: "1", registry: "1", version: "1"},
-            secondPlugin: {package: "2", registry: "2", version: "2"}
+            firstPlugin: {package: "1", location: "1", version: "1"},
+            secondPlugin: {package: "2", location: "2", version: "2"}
         };
         const loadPluginCfgPropsReal: any = PMF.loadPluginCfgProps;
         const loadPluginCfgPropsMock = jest.fn();

packages/imperative/src/imperative/__tests__/plugins/cmd/install/install.handler.unit.test.ts

@@ -51,19 +51,21 @@ import { Logger } from "../../../../../logger";
 import { readFileSync, writeFileSync } from "jsonfile";
 import { PMFConstants } from "../../../../src/plugins/utilities/PMFConstants";
 import { TextUtils } from "../../../../../utilities";
-import { getRegistry, npmLogin } from "../../../../src/plugins/utilities/NpmFunctions";
+import { getRegistry, getScopeRegistry, npmLogin } from "../../../../src/plugins/utilities/NpmFunctions";
 import * as spawn from "cross-spawn";
+import { IO } from "../../../../../io";
 
 describe("Plugin Management Facility install handler", () => {
 
     // Objects created so types are correct.
     const mocks = {
         npmLogin: npmLogin as Mock<typeof npmLogin>,
         getRegistry: getRegistry as unknown as Mock<typeof getRegistry>,
+        getScopeRegistry: getScopeRegistry as unknown as Mock<typeof getScopeRegistry>,
         readFileSync: readFileSync as Mock<typeof readFileSync>,
         writeFileSync: writeFileSync as Mock<typeof writeFileSync>,
         install: install as unknown as Mock<typeof install>,
-        runValidatePlugin: runValidatePlugin as unknown as Mock<typeof runValidatePlugin>
+        runValidatePlugin: runValidatePlugin as unknown as Mock<typeof runValidatePlugin>,
     };
 
     // two plugin set of values
@@ -180,12 +182,12 @@ describe("Plugin Management Facility install handler", () => {
         const fileJson: IPluginJson = {
             a: {
                 package: packageName,
-                registry: "",
+                location: "",
                 version: packageVersion
             },
             plugin2: {
                 package: packageName2,
-                registry: packageRegistry2,
+                location: packageRegistry2,
                 version: packageVersion2
             }
         };
@@ -379,5 +381,90 @@ describe("Plugin Management Facility install handler", () => {
         expect(expectedError.additionalDetails).toContain("Command failed");
         expect(expectedError.additionalDetails).toContain("npm");
     });
+    it("should handle installed plugins via public scope", async () => {
+        const handler = new InstallHandler();
+
+        const params = getIHandlerParametersObject();
+        params.arguments.plugin = ["@public/sample1"];
+
+        mocks.getScopeRegistry.mockReturnValueOnce("publicRegistryUrl" as any);
+
+        try {
+            await handler.process(params);
+        } catch (e) {
+            expect(e).toBeUndefined();
+        }
+
+        expect(mocks.install).toHaveBeenCalledWith("@public/sample1","publicRegistryUrl");
+    });
+    it("should handle installed plugins via private scope", async () => {
+        const handler = new InstallHandler();
+
+        const params = getIHandlerParametersObject();
+        params.arguments.plugin = ["@private/sample1"];
+
+        mocks.getScopeRegistry.mockReturnValueOnce("privateRegistryUrl" as any);
+
+        try{
+            await handler.process(params);
+        }
+        catch(e){
+            expect(e).toBeUndefined();
+        }
+
+        expect(mocks.install).toHaveBeenCalledWith("@private/sample1","privateRegistryUrl")
+    });
+    it("should handle installed plugins via project/directory", async () => {
+        const handler = new InstallHandler();
+
+        const params = getIHandlerParametersObject();
+        params.arguments.plugin = ["path/to/dir"];
+        jest.spyOn(IO, 'isDir').mockReturnValue(true);
+
+        try{
+            await handler.process(params);
+        }
+        catch(e){
+            expect(e).toBeUndefined();
+        }
+
+        expect(mocks.install).toHaveBeenCalledWith("path/to/dir","path/to/dir");
+    });
+    it("should handle installed plugins via tarball file", async () => {
+        const handler = new InstallHandler();
+
+        const params = getIHandlerParametersObject();
+        params.arguments.plugin = ["path/to/dir/file.tgz"];
+
+        try{
+            await handler.process(params);
+        }
+        catch(e){
+            expect(e).toBeUndefined();
+        }
+
+        expect(mocks.install).toHaveBeenCalledWith("path/to/dir/file.tgz","path/to/dir/file.tgz");
+    });
+    it("should handle multiple installed plugins via tarball, director, public registry, and private registry", async () => {
+        const handler = new InstallHandler();
+
+        const params = getIHandlerParametersObject();
+        params.arguments.plugin = ["@public/sample1","@private/sample1","path/to/dir","path/to/dir/file.tgz"];
+        mocks.getScopeRegistry.mockReturnValueOnce("publicRegistryUrl" as any);
+        mocks.getScopeRegistry.mockReturnValueOnce("privateRegistryUrl" as any);
+        jest.spyOn(IO, 'isDir').mockReturnValue(true);
+
+        try{
+            await handler.process(params);
+        }
+        catch(e){
+            expect(e).toBeUndefined();
+        }
+
+        expect(mocks.install).toHaveBeenCalledWith("@public/sample1","publicRegistryUrl");
+        expect(mocks.install).toHaveBeenCalledWith("@private/sample1","privateRegistryUrl");
+        expect(mocks.install).toHaveBeenCalledWith("path/to/dir","path/to/dir");
+        expect(mocks.install).toHaveBeenCalledWith("path/to/dir/file.tgz","path/to/dir/file.tgz");
+    });
 });
 

packages/imperative/src/imperative/__tests__/plugins/cmd/list/__snapshots__/list.handler.unit.test.ts.snap

@@ -7,12 +7,12 @@ Installed plugins:
  -- pluginName: a 
  -- package: a 
  -- version: 22.1.0 
- -- registry: http://imperative-npm-registry:4873/
+ -- location: http://imperative-npm-registry:4873/
 
  -- pluginName: plugin1 
  -- package: plugin1 
  -- version: 2.0.3 
- -- registry: http://imperative-npm-registry:4873/
+ -- location: http://imperative-npm-registry:4873/
 
 "
 `;

packages/imperative/src/imperative/__tests__/plugins/cmd/list/list.handler.unit.test.ts

@@ -90,12 +90,12 @@ describe("Plugin Management Facility list handler", () => {
         const fileJson: IPluginJson = {
             plugin1: {
                 package: packageName2,
-                registry: packageRegistry2,
+                location: packageRegistry2,
                 version: packageVersion2
             },
             a: {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             }
         };
@@ -119,12 +119,12 @@ describe("Plugin Management Facility list handler", () => {
         const fileJson: IPluginJson = {
             plugin1: {
                 package: packageName2,
-                registry: packageRegistry2,
+                location: packageRegistry2,
                 version: packageVersion2
             },
             a: {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             }
         };

packages/imperative/src/imperative/__tests__/plugins/cmd/uninstall/uninstall.handler.unit.test.ts

@@ -114,12 +114,12 @@ describe("Plugin Management Facility uninstall handler", () => {
         const fileJson: IPluginJson = {
             a: {
                 package: packageName,
-                registry: "",
+                location: "",
                 version: packageVersion
             },
             plugin1: {
                 package: packageName2,
-                registry: packageRegistry2,
+                location: packageRegistry2,
                 version: packageVersion2
             }
         };

packages/imperative/src/imperative/__tests__/plugins/cmd/update/update.handler.unit.test.ts

@@ -137,12 +137,12 @@ describe("Plugin Management Facility update handler", () => {
         const fileJson: IPluginJson = {
             "imperative-sample-plugin": {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             },
             "plugin1": {
                 package: packageName2,
-                registry: packageRegistry2,
+                location: packageRegistry2,
                 version: packageVersion2
             }
         };
@@ -173,7 +173,7 @@ describe("Plugin Management Facility update handler", () => {
         const fileJson: IPluginJson = {
             "imperative-sample-plugin": {
                 package: resolveVal,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: "1.0.1"
             }
         };

packages/imperative/src/imperative/__tests__/plugins/utilities/NpmFunctions.unit.test.ts

@@ -15,6 +15,7 @@
 import * as pacote from "pacote";
 import * as npmFunctions from "../../../src/plugins/utilities/NpmFunctions";
 import { PMFConstants } from "../../../src/plugins/utilities/PMFConstants";
+import { ExecUtils } from "../../../../utilities";
 
 jest.mock("cross-spawn");
 jest.mock("jsonfile");
@@ -134,5 +135,7 @@
             expect(actualInfo).toBe(expectedInfo);
             expect(pacote.manifest).toHaveBeenCalledTimes(1);
         });
+
+
     });
 });

packages/imperative/src/imperative/__tests__/plugins/utilities/npm-interface/install.unit.test.ts

@@ -198,7 +198,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(packageName, packageRegistry);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -214,7 +214,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(rootFile, packageRegistry);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: rootFile,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -230,7 +230,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(rootFile, packageRegistry);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: rootFile,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -257,7 +257,7 @@ describe("PMF: Install Interface", () => {
                 wasNpmInstallCallValid(absolutePath, packageRegistry);
                 wasWriteFileSyncCallValid({}, packageName, {
                     package: absolutePath,
-                    registry: packageRegistry,
+                    location: packageRegistry,
                     version: packageVersion
                 });
             });
@@ -274,7 +274,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(installUrl, packageRegistry);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: installUrl,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -288,7 +288,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(packageName, packageRegistry, false);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -339,7 +339,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(semverPackage, packageRegistry);
             wasWriteFileSyncCallValid({}, packageName, {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: semverVersion
             });
         });
@@ -349,7 +349,7 @@ describe("PMF: Install Interface", () => {
             const oneOldPlugin: IPluginJson = {
                 plugin1: {
                     package: "plugin1",
-                    registry: packageRegistry,
+                    location: packageRegistry,
                     version: "1.2.3"
                 }
             };
@@ -368,7 +368,7 @@ describe("PMF: Install Interface", () => {
             wasNpmInstallCallValid(packageName, packageRegistry);
             wasWriteFileSyncCallValid(oneOldPlugin, packageName, {
                 package: packageName,
-                registry: packageRegistry,
+                location: packageRegistry,
                 version: packageVersion
             });
         });
@@ -383,7 +383,7 @@ describe("PMF: Install Interface", () => {
                 const oneOldPlugin: IPluginJson = {
                     plugin1: {
                         package: "plugin1",
-                        registry: packageRegistry,
+                        location: packageRegistry,
                         version: "1.2.3"
                     }
                 };