Merge pull request #1856 from zowe/removeDeprecatedImp

Remove deprecated imperative constants, options, and methods - Imperative

packages/core/__tests__/apiml/__unit__/allPluginCfgPropsMock.json

@@ -6,7 +6,6 @@
       "commandModuleGlobs": [
         "**/*.definition!(.d).*s"
       ],
-      "pluginHealthCheck": "./lib/HealthCheck.handler",
       "rootCommandDescription": "CA Endevor SCM plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.",
       "envVariablePrefix": "ENDEVOR",
       "defaultHome": "C:\\Users\\ej608771/.endevor",
@@ -309,7 +308,6 @@
       "commandModuleGlobs": [
         "**/cli/*/*.definition!(.d).*s"
       ],
-      "pluginHealthCheck": "C:\\Users\\ej608771\\.zowe\\plugins\\installed\\node_modules\\@broadcom\\jclcheck-for-zowe-cli\\lib/healthCheck.handler",
       "pluginSummary": "JCLCheck plugin",
       "pluginAliases": [
         "jck"

packages/imperative/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- LTS Breaking: Removed the following previously deprecated items:
+  - `flattenCommandTreeWithAliases()` -- Use `CommandUtils.flattenCommandTree()` instead
+  - `AbstractAuthHandler.getPromptParams()` -- Use `getAuthHandlerApi()` instead
+  - `BaseAuthHandler.getPromptParams()` -- Use `getAuthHandlerApi()` instead
+  - `promptForInput()` -- Use the asynchronous method `readPrompt()` instead
+  - `promptWithTimeout()` -- Use `readPrompt` instead which supports more options
+  - `Imperative.envVariablePrefix` -- Use `ImperativeConfig.instance.envVariablePrefix` instead
+  - `pluginHealthCheck()` -- Plugins that want to perform a health check can
+    specify the `pluginLifeCycle` property to load a class from the plugin.
+    The plugin can implement the `postInstall()` function of that class to perform
+    a health check, or any other desired operation.
+  - `IProfOpts.requireKeytar` -- removing the default implementation of `require("keytar")` from the caller app's node_modules folders
+
 ## `8.0.0-next.202311141517`
 
 - LTS Breaking: Replaced the previously deprecated function AbstractCommandYargs.getBrightYargsResponse - use AbstractCommandYargs.getZoweYargsResponse

packages/imperative/__tests__/src/packages/imperative/plugins/suites/ValidatePlugin.ts

@@ -247,88 +247,6 @@ describe("Validate plugin", () => {
                 expect(result.status).toEqual(1);
             });
 
-            // TODO: remove this test in V3, when pluginHealthCheck is removed
-            it("missing pluginHealthCheck property", () => {
-                const testPlugin = "missing_pluginHealthCheck";
-                const fullPluginPath = join(testPluginDir, "error_plugins", testPlugin);
-
-                let cmd = `plugins install ${fullPluginPath}`;
-                let result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                expect(result.stdout).toContain(`Installed plugin name = '${testPlugin}'`);
-
-                cmd = `plugins validate ${testPlugin}`;
-                result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                result.stderr = removeNewline(result.stderr);
-                expect(result.stdout).toContain(testPlugin);
-                expect(result.stdout).toContain("This plugin was successfully validated. Enjoy the plugin.");
-                expect(result.stdout).not.toContain("Warning");
-                expect(result.stdout).not.toContain("The plugin's configuration does not contain an 'imperative.pluginHealthCheck' property.");
-                expect(result.stderr).not.toContain("Problems detected during plugin validation.");
-                expect(result.status).toEqual(0);
-            });
-
-            // TODO: remove this test in V3, when pluginHealthCheck is removed
-            it("missing pluginHealthCheck property - warning", () => {
-                const testPlugin = "missing_pluginHealthCheck";
-                const fullPluginPath = join(testPluginDir, "error_plugins", testPlugin);
-
-                let cmd = `plugins install ${fullPluginPath}`;
-                let result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                expect(result.stdout).toContain(`Installed plugin name = '${testPlugin}'`);
-
-                cmd = `plugins validate ${testPlugin} --fail-on-warning`;
-                result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                result.stderr = removeNewline(result.stderr);
-                expect(result.stdout).toContain(testPlugin);
-                expect(result.stdout).toContain("This plugin was successfully validated. Enjoy the plugin.");
-                expect(result.stdout).not.toContain("Warning");
-                expect(result.stdout).not.toContain("The plugin's configuration does not contain an 'imperative.pluginHealthCheck' property.");
-                expect(result.stderr).not.toContain("Problems detected during plugin validation.");
-                expect(result.status).toEqual(0);
-            });
-
-            // TODO: remove this test in V3, when pluginHealthCheck is removed
-            it("missing pluginHealthCheck handler", () => {
-                const testPlugin = "missing_healthcheck_handler";
-                const fullPluginPath = join(testPluginDir, "error_plugins", testPlugin);
-
-                let cmd = `plugins install ${fullPluginPath}`;
-                let result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                expect(result.stdout).toContain(`Installed plugin name = '${testPlugin}'`);
-
-                cmd = `plugins validate ${testPlugin} --no-fail-on-error`;
-                result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                result.stderr = removeNewline(result.stderr);
-                expect(result.stdout).toContain(testPlugin);
-                expect(result.stdout).toContain("This plugin was successfully validated. Enjoy the plugin.");
-                expect(result.stdout).not.toContain("Error");
-                expect(result.stdout).not.toContain(`The program for the 'imperative.pluginHealthCheck' property does not exist:`);
-                expect(result.stdout).not.toContain("This plugin has configuration errors. No component of the plugin will be available");
-                expect(result.stderr).not.toContain("Problems detected during plugin validation.");
-                expect(result.status).toEqual(0);
-            });
-
-            // TODO: remove this test in V3, when pluginHealthCheck is removed
-            it("missing pluginHealthCheck handler - error", () => {
-                const testPlugin = "missing_healthcheck_handler";
-                const fullPluginPath = join(testPluginDir, "error_plugins", testPlugin);
-
-                let cmd = `plugins install ${fullPluginPath}`;
-                let result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                expect(result.stdout).toContain(`Installed plugin name = '${testPlugin}'`);
-
-                cmd = `plugins validate ${testPlugin}`;
-                result = T.executeTestCLICommand(cliBin, this, cmd.split(" "));
-                result.stderr = removeNewline(result.stderr);
-                expect(result.stdout).toContain(testPlugin);
-                expect(result.stdout).toContain("This plugin was successfully validated. Enjoy the plugin.");
-                expect(result.stdout).not.toContain("Error");
-                expect(result.stdout).not.toContain(`The program for the 'imperative.pluginHealthCheck' property does not exist:`);
-                expect(result.stdout).not.toContain("This plugin has configuration errors. No component of the plugin will be available");
-                expect(result.stderr).not.toContain("Problems detected during plugin validation.");
-                expect(result.status).toEqual(0);
-            });
-
             it("missing peerDependencies properties", () => {
                 const testPlugin = "missing_dependencies";
                 const fullPluginPath = join(testPluginDir, "error_plugins", testPlugin);

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/chained_handler_plugin/package.json

@@ -10,7 +10,6 @@
     "name": "chained-handler-plugin",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./lib/sample-plugin/healthCheck.handler",
     "pluginAliases": [
       "chp",
       "chainedhandlerp"

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_bad_chained_handler/package.json

@@ -10,7 +10,6 @@
     "name": "definition_bad_chained_handler",
     "rootCommandDescription": "definition bad chained handler",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_empty_array/package.json

@@ -10,7 +10,6 @@
     "name": "definition_empty_array",
     "rootCommandDescription": "definition empty array",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": []
   },
   "peerDependencies": {

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_empty_chained_handler/package.json

@@ -10,7 +10,6 @@
     "name": "definition_empty_chained_handler",
     "rootCommandDescription": "definition empty chained handler",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_missing_chained_handler/package.json

@@ -10,7 +10,6 @@
     "name": "definition_missing_chained_handler",
     "rootCommandDescription": "definition missing chained handler",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_missing_description/package.json

@@ -10,7 +10,6 @@
     "name": "definition_missing_description",
     "rootCommandDescription": "definition missing description",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_missing_handler/package.json

@@ -10,7 +10,6 @@
     "name": "definition_missing_handler",
     "rootCommandDescription": "definition missing handler",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_missing_name/package.json

@@ -10,7 +10,6 @@
     "name": "definition_missing_name",
     "rootCommandDescription": "definition missing name",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "description": "dummy foo command",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_missing_type/package.json

@@ -10,7 +10,6 @@
     "name": "definition_missing_type",
     "rootCommandDescription": "definition missing type",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/definition_type_group_without_children/package.json

@@ -10,7 +10,6 @@
     "name": "definition_type_group_without_children",
     "rootCommandDescription": "definition type group without children",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/duplicated_base_cli_command/package.json

@@ -10,7 +10,6 @@
     "name": "plugins",
     "rootCommandDescription": "duplicated base cli command",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/duplicated_installed_plugin_command/package.json

@@ -10,7 +10,6 @@
     "name": "normal-plugin",
     "rootCommandDescription": "duplicated installed plugin command",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/incompatible_imperative_version/package.json

@@ -10,7 +10,6 @@
     "name": "incompatible_imperative_version",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^2.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_command_handler/package.json

@@ -10,7 +10,6 @@
     "name": "missing_command_handler",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_definitions/package.json

@@ -9,8 +9,7 @@
   "imperative": {
     "name": "missing_definitions",
     "rootCommandDescription": "missing definitions",
-    "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler"
+    "pluginBaseCliVersion": "^1.0.0"
   },
   "peerDependencies": {
     "@zowe/imperative": "1.0.0"

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_dependencies/package.json

@@ -10,7 +10,6 @@
     "name": "missing_dependencies",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_healthcheck_handler/package.json

@@ -10,7 +10,6 @@
     "name": "missing_healthcheck_handler",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./non_existing_path",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_pluginBaseCliVersion/package.json

@@ -9,7 +9,6 @@
   "imperative": {
     "name": "missing_pluginBaseCliVersion",
     "rootCommandDescription": "imperative working test plugin",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/error_plugins/missing_rootCommandDescription/package.json

@@ -9,7 +9,6 @@
   "imperative": {
     "name": "missing_rootCommandDescription",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/missing_name_plugin/package.json

@@ -9,7 +9,6 @@
   "imperative": {
     "rootCommandDescription": "missing name plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./dummy.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/normal_plugin/package.json

@@ -10,7 +10,6 @@
     "name": "normal-plugin",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./lib/sample-plugin/healthCheck.handler",
     "pluginAliases": [
       "np",
       "normalp"

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/normal_plugin_2/package.json

@@ -10,7 +10,6 @@
     "name": "normal-plugin-2",
     "rootCommandDescription": "imperative working test plugin 2",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./lib/sample-plugin/healthCheck.handler",
     "definitions": [
       {
         "name": "foo",

packages/imperative/__tests__/src/packages/imperative/plugins/test_plugins/normal_plugin_misc/package.json

@@ -10,7 +10,6 @@
     "name": "normal-plugin-misc",
     "rootCommandDescription": "imperative working test plugin",
     "pluginBaseCliVersion": "^1.0.0",
-    "pluginHealthCheck": "./lib/sample-plugin/healthCheck.handler",
     "pluginAliases": [
       "misc"
     ],