Deprecate duplicate functions

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>
zowe · Nov 5, 2024 · 90924fa · 90924fa
1 parent 7d63b8b
commit 90924fa
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 19 deletions.
diff --git a/__tests__/__packages__/cli-test-utils/src/environment/TestEnvironment.ts b/__tests__/__packages__/cli-test-utils/src/environment/TestEnvironment.ts
@@ -114,7 +114,7 @@ export class TestEnvironment {
     public static createUniqueTestDataDir(testName: string): string {
         const app = uuidv4() + "_" + testName + "/";
         const path = nodePath.resolve(TEST_RESULT_DATA_DIR + "/" + app);
-        IO.mkdirp(path);
+        IO.createDirSync(path);
         return path;
     }
 

diff --git a/...ges/cli/__tests__/zosjobs/__system__/download/cli.zos-jobs.download.output.system.test.ts b/...ges/cli/__tests__/zosjobs/__system__/download/cli.zos-jobs.download.output.system.test.ts
@@ -14,8 +14,6 @@ import { ITestEnvironment } from "../../../../../../__tests__/__src__/environmen
 import { runCliScript } from "@zowe/cli-test-utils";
 import { ITestPropertiesSchema } from "../../../../../../__tests__/__src__/properties/ITestPropertiesSchema";
 import * as fs from "fs";
-import { Session } from "@zowe/imperative";
-import { GetJobs } from "@zowe/zos-jobs-for-zowe-sdk";
 
 // Test Environment populated in the beforeAll();
 let TEST_ENVIRONMENT: ITestEnvironment<ITestPropertiesSchema>;
@@ -49,14 +47,14 @@ describe("zos-jobs download output command", () => {
         it("should download a job and wait for it to reach output status", async () => {
             const response = runCliScript(__dirname + "/__scripts__/download-output/download_job_wait_for_output.sh",
                 TEST_ENVIRONMENT, [IEFBR14_JCL]);
-                expect(response.stderr.toString()).toBe("");
-                expect(response.status).toBe(0);
+            expect(response.stderr.toString()).toBe("");
+            expect(response.status).toBe(0);
         });
         it("should download a job and wait for it to reach active status", async () => {
             const response = runCliScript(__dirname + "/__scripts__/download-output/download_job_wait_for_active.sh",
                 TEST_ENVIRONMENT, [IEFBR14_JCL]);
-                expect(response.stderr.toString()).toBe("");
-                expect(response.status).toBe(0);
+            expect(response.stderr.toString()).toBe("");
+            expect(response.status).toBe(0);
         });
     });
     describe("output", () => {

diff --git a/packages/cli/src/daemon/DaemonUtil.ts b/packages/cli/src/daemon/DaemonUtil.ts
@@ -37,7 +37,7 @@ export class DaemonUtil {
         }
         if (!IO.existsSync(daemonDir)) {
             try {
-                IO.mkdirp(daemonDir);
+                IO.createDirSync(daemonDir);
                 const ownerReadWriteTraverse = 0o700;
                 fs.chmodSync(daemonDir, ownerReadWriteTraverse);
             } catch(err) {

diff --git a/packages/imperative/CHANGELOG.md b/packages/imperative/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the Imperative package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Deprecated `IO` functions `createDirsSync` and `mkdirp` due to code duplication. Please use `createDirSync`. [#2352](https://github.com/zowe/zowe-cli/pull/2352)
+
 ## `8.7.0`
 
 - Enhancement: Added optional `proxy` object to ISession interface for extenders to pass a ProxyVariables object that would override the environment variables if in place. [#2330](https://github.com/zowe/zowe-cli/pull/2330)

diff --git a/..._/src/packages/imperative/__integration__/PluginManagementFacility.integration.subtest.ts b/..._/src/packages/imperative/__integration__/PluginManagementFacility.integration.subtest.ts
@@ -33,7 +33,7 @@ describe("Plugin Management Facility", () => {
          * expect to see them.
          */
         const namespaceDirPath = join(testCliNodeModulePath, "@zowe");
-        IO.mkdirp(namespaceDirPath);
+        IO.createDirSync(namespaceDirPath);
         const testCliImpSymLink = join(namespaceDirPath, "imperative");
         IO.createSymlinkToDir(testCliImpSymLink, impLibDir);
     });
@@ -42,7 +42,7 @@ describe("Plugin Management Facility", () => {
         T.rimraf(home);
         // Some test may still need this directory to exists in order to spawn zowe commands in that location
         // (e.g. node --require ts-node/register <absolute-path-for-TestCLI.ts> config init)
-        IO.mkdirp(home);
+        IO.createDirSync(home);
     });
 
     afterAll(() => {

diff --git a/packages/imperative/src/cmd/__tests__/help/WebHelpGenerator.unit.test.ts b/packages/imperative/src/cmd/__tests__/help/WebHelpGenerator.unit.test.ts
@@ -118,7 +118,7 @@ describe("WebHelpGenerator", () => {
              */
             const webHelpDocsDirNm = webHelpDirNm + "/docs";
             if (!existsSync(webHelpDocsDirNm)) {
-                IO.mkdirp(webHelpDocsDirNm);
+                IO.createDirSync(webHelpDocsDirNm);
             }
 
             const webHelpGen = new WebHelpGenerator(

diff --git a/packages/imperative/src/cmd/__tests__/help/WebHelpManager.unit.test.ts b/packages/imperative/src/cmd/__tests__/help/WebHelpManager.unit.test.ts
@@ -103,7 +103,7 @@ describe("WebHelpManager", () => {
                 // ensure that the plugins directory exists
                 instPluginsFileNm = path.join(mockCliHome, "plugins");
                 if (!fs.existsSync(instPluginsFileNm)) {
-                    IO.mkdirp(instPluginsFileNm);
+                    IO.createDirSync(instPluginsFileNm);
                 }
 
                 // add the plugins file name to the directory, and create an empty object
@@ -118,7 +118,7 @@ describe("WebHelpManager", () => {
                 */
                 const webHelpDocsDirNm = webHelpDirNm + "/docs";
                 if (!fs.existsSync(webHelpDocsDirNm)) {
-                    IO.mkdirp(webHelpDocsDirNm);
+                    IO.createDirSync(webHelpDocsDirNm);
                 }
             });
 

diff --git a/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts b/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts
@@ -228,7 +228,7 @@ export class PluginManagementFacility {
         if (!existsSync(this.pmfConst.PLUGIN_JSON)) {
             if (!existsSync(this.pmfConst.PMF_ROOT)) {
                 this.impLogger.debug("Creating PMF_ROOT directory");
-                IO.mkdirp(this.pmfConst.PMF_ROOT);
+                IO.createDirSync(this.pmfConst.PMF_ROOT);
             }
 
             this.impLogger.debug("Creating PLUGIN_JSON file");

diff --git a/packages/imperative/src/io/__tests__/IO.unit.test.ts b/packages/imperative/src/io/__tests__/IO.unit.test.ts
@@ -133,6 +133,7 @@ describe("IO tests", () => {
     it("should get an error for no input on createDirsSync", () => {
         let error;
         try {
+            // eslint-disable-next-line deprecation/deprecation
             IO.createDirsSync("   ");
         } catch (thrownError) {
             error = thrownError;
@@ -152,6 +153,7 @@ describe("IO tests", () => {
         });
         const willBeADir = ["pretend", "to", "create"];
         const dir = willBeADir.join(path.posix.sep);
+        // eslint-disable-next-line deprecation/deprecation
         IO.createDirsSync(dir);
         expect(fnFm).toHaveBeenCalledTimes(willBeADir.length);
     });
@@ -168,6 +170,7 @@ describe("IO tests", () => {
         });
         const willBeADir = ["pretend", "to", "create"];
         const dir = willBeADir.join(path.posix.sep);
+        // eslint-disable-next-line deprecation/deprecation
         IO.createDirsSync(dir);
         expect(fnFm).not.toHaveBeenCalled();
     });
@@ -188,6 +191,7 @@ describe("IO tests", () => {
             return pathSegments[0];
         });
         const dir = willBeADir.join(path.posix.sep);
+        // eslint-disable-next-line deprecation/deprecation
         IO.createDirsSync(dir);
         expect(fnFm).toHaveBeenCalledTimes(willBeADir.length - 1);
     });
@@ -279,6 +283,7 @@ describe("IO tests", () => {
     it("should get an error for no input on mkdirp", () => {
         let error;
         try {
+            // eslint-disable-next-line deprecation/deprecation
             IO.mkdirp("   ");
         } catch (thrownError) {
             error = thrownError;

diff --git a/packages/imperative/src/io/src/IO.ts b/packages/imperative/src/io/src/IO.ts
@@ -127,6 +127,7 @@ export class IO {
      * @static
      * @param {string} dir - directory to create all sub directories for
      * @memberof IO
+     * @deprecated Please use IO.createDirSync
      */
     public static createDirsSync(dir: string) {
         ImperativeExpect.toBeDefinedAndNonBlank(dir, "dir");
@@ -153,7 +154,7 @@ export class IO {
      */
     public static createDirsSyncFromFilePath(filePath: string) {
         ImperativeExpect.toBeDefinedAndNonBlank(filePath, "filePath");
-        IO.createDirsSync(path.dirname(filePath));
+        IO.createDirSync(path.dirname(filePath));
     }
 
     /**
@@ -200,6 +201,7 @@ export class IO {
      * @static
      * @param {string} dir - the directory (do not include a file name)
      * @memberof IO
+     * @deprecated Please use IO.createDirSync
      */
     public static mkdirp(dir: string) {
         ImperativeExpect.toBeDefinedAndNonBlank(dir, "dir");

diff --git a/packages/imperative/src/rest/__tests__/client/AbstractRestClient.unit.test.ts b/packages/imperative/src/rest/__tests__/client/AbstractRestClient.unit.test.ts
@@ -1517,7 +1517,7 @@ describe("AbstractRestClient tests", () => {
                 const result = privateRestClient.buildOptions(resource, request, reqHeaders);
                 expect(Object.keys(result)).toContain('agent');
                 expect(headerSpy).toHaveBeenCalledWith([{'Proxy-Authorization': restSession.ISession.proxy.proxy_authorization}]);
-            })
+            });
         });
     });
 });
diff --git a/packages/imperative/src/rest/__tests__/client/ProxySettings.unit.test.ts b/packages/imperative/src/rest/__tests__/client/ProxySettings.unit.test.ts
@@ -41,7 +41,7 @@ describe("Proxy tests", () => {
         const expected = {
             proxyUrl: passedUrl,
             protocol: HTTPS_PROTOCOL
-        }
+        };
 
         beforeEach(() => {
             jest.clearAllMocks();

diff --git a/packages/imperative/src/rest/src/client/AbstractRestClient.ts b/packages/imperative/src/rest/src/client/AbstractRestClient.ts
@@ -478,7 +478,7 @@ export abstract class AbstractRestClient {
                 this.mLogger.info(`Using the following proxy setting for the request: ${proxyUrl.href}`);
                 if (this.session.ISession?.proxy?.proxy_authorization) {
                     reqHeaders.push({ 'Proxy-Authorization': this.session.ISession.proxy.proxy_authorization});
-                 }
+                }
                 options.agent = ProxySettings.getProxyAgent(this.session.ISession);
             }
         }

diff --git a/packages/imperative/src/utilities/__tests__/diff/WebDiffGenerator.unit.test.ts b/packages/imperative/src/utilities/__tests__/diff/WebDiffGenerator.unit.test.ts
@@ -26,7 +26,7 @@ describe("WebDiffGenerator", () => {
         beforeAll(async () => {
             // checking if fakewebdiffdir exists or not
             if (!fs.existsSync(webDiffDir)) {
-                IO.mkdirp(webDiffDir);
+                IO.createDirSync(webDiffDir);
             }
         });
         afterAll(async () => {