Merge pull request #773 from ap891843/feature/supportRelativepathCpyBook

feat: Support copybooks outside the current workspace #755

Author: grianbrcom

clients/cobol-lsp-vscode-extension/src/__tests__/CopybookResolveURITest.spec.ts

@@ -14,19 +14,20 @@
 import * as fs from "fs-extra";
 import * as path from "path";
 import * as vscode from "vscode";
-import {CopybookURI} from "../services/copybook/CopybookURI";
-import {ProfileService} from "../services/ProfileService";
-import {SettingsUtils} from "../services/util/SettingsUtils";
-import {ZoweApi} from "../services/ZoweApi";
+import { CopybookURI } from "../services/copybook/CopybookURI";
+import { ProfileService } from "../services/ProfileService";
+import { SettingsUtils } from "../services/util/SettingsUtils";
+import { ZoweApi } from "../services/ZoweApi";
 import * as fsUtils from "../services/util/FSUtils";
-import {COPYBOOK_EXT_ARRAY} from "../constants";
+import { COPYBOOK_EXT_ARRAY } from "../constants";
 
 const zoweApi: ZoweApi = new ZoweApi();
 const profileService: ProfileService = new ProfileService(zoweApi);
 const copybookURI: CopybookURI = new CopybookURI(profileService);
 const copybookName: string = "NSTCOPY1";
 const copybookNameWithExtension: string = "NSTCOPY2.CPY";
 const CPY_FOLDER_NAME = ".cobcopy";
+const RELATIVE_CPY_FOLDER_NAME = "../relativeCobcopy";
 const folderPath = path.join(__dirname, CPY_FOLDER_NAME);
 SettingsUtils.getWorkspacesURI = jest.fn().mockReturnValue(["file://" + __dirname]);
 profileService.resolveProfile = jest.fn().mockReturnValue("PRF");
@@ -35,7 +36,7 @@ vscode.workspace.getConfiguration = jest.fn().mockReturnValue({
 });
 
 // file utils
-function createFile(filename: string): string {
+function createFile(filename: string, folderPath: string): string {
     fs.writeFileSync(path.join(folderPath, filename), "Some dummy content", err => {
         if (err) {
             return null;
@@ -46,13 +47,17 @@ function createFile(filename: string): string {
 
 function createDirectory(targetPath: string) {
 
-    fs.mkdirSync(targetPath, {recursive: true});
+    fs.mkdirSync(targetPath, { recursive: true });
 }
 
 function removeFolder(pathFile: string) {
     fs.remove(pathFile);
 }
 
+function removeNonEmptyFolder(targetPath: string) {
+    fs.rmdirSync(targetPath, { recursive: true });
+}
+
 function buildResultArrayFrom(settingsMockValue: string[], profileName: string): number {
     vscode.workspace.getConfiguration = jest.fn().mockReturnValue({
         get: jest.fn().mockReturnValue(settingsMockValue),
@@ -65,8 +70,8 @@ beforeEach(() => {
 });
 beforeAll(() => {
     createDirectory(folderPath);
-    createFile(copybookName);
-    createFile(copybookNameWithExtension);
+    createFile(copybookName, folderPath);
+    createFile(copybookNameWithExtension, folderPath);
 });
 afterAll(() => {
     return removeFolder(folderPath);
@@ -95,6 +100,16 @@ describe("Resolve local copybook present in one or more folders specified by the
     test("Given a copybook with extension on filesystem, the uri is correctly returned", () => {
         expect(fsUtils.searchInWorkspace("NSTCOPY2", [CPY_FOLDER_NAME], COPYBOOK_EXT_ARRAY)).toBeDefined();
     });
+    test("Given a valid relative path for copybook with extension on filesystem, the uri is correctly returned", () => {
+        const dir = path.join(__dirname, RELATIVE_CPY_FOLDER_NAME);
+        createDirectory(dir);
+        createFile(copybookNameWithExtension, dir);
+        expect(fsUtils.searchInWorkspace("NSTCOPY2", [RELATIVE_CPY_FOLDER_NAME], COPYBOOK_EXT_ARRAY)).toBeDefined();
+        removeNonEmptyFolder(dir);
+    });
+    test("Given a valid absolute path for copybook with extension on filesystem, the uri is correctly returned", () => {
+        expect(fsUtils.searchInWorkspace("NSTCOPY2", [path.normalize(folderPath)], COPYBOOK_EXT_ARRAY)).toBeDefined();
+    });
 });
 describe("With invalid input parameters, the list of URI that represent copybook downloaded are not generated", () => {
     test("given a profile but no dataset, the result list returned is empty", () => {
@@ -136,9 +151,9 @@ describe("Prioritize search criteria for copybooks test suite", () => {
     });
     test("With both local and dsn references defined in the settings.json, the search is applied on local resources" +
         "first", async () => {
-        provideMockValueForLocalAndDSN(CPY_FOLDER_NAME, "");
-        const uri: string = await copybookURI.resolveCopybookURI(copybookName, "PRGNAME");
-        expect(uri).not.toBe("");
-        expect(spySearchInWorkspace).toBeCalledTimes(1);
-    });
+            provideMockValueForLocalAndDSN(CPY_FOLDER_NAME, "");
+            const uri: string = await copybookURI.resolveCopybookURI(copybookName, "PRGNAME");
+            expect(uri).not.toBe("");
+            expect(spySearchInWorkspace).toBeCalledTimes(1);
+        });
 });

clients/cobol-lsp-vscode-extension/src/services/util/FSUtils.ts

@@ -12,10 +12,10 @@
  *   Broadcom, Inc. - initial API and implementation
  */
 
-import {URL} from "url";
+import * as urlUtil from "url";
 import * as path from "path";
-import {readdirSync, existsSync} from "fs";
-import {SettingsUtils} from "./SettingsUtils";
+import { readdirSync, existsSync } from "fs";
+import { SettingsUtils } from "./SettingsUtils";
 import * as fs from "fs";
 
 /**
@@ -27,19 +27,19 @@ import * as fs from "fs";
  * this URI really exists on FS.
  *
  */
-export function getURIFrom(folder: string, entityName: string, extensions?: string[]): URL {
+export function getURIFrom(folder: string, entityName: string, extensions?: string[]): urlUtil.URL {
     if (!extensions) {
-        const url = new URL(path.join(folder, entityName));
+        const url = new urlUtil.URL(path.join(folder, entityName));
         if (existsSync(url)) {
             return url;
         }
     } else {
-        const fileList = readdirSync(new URL(folder));
+        const fileList = readdirSync(new urlUtil.URL(folder));
         for (const extension of extensions) {
             const copybookFileWithExtension = (entityName + extension).toUpperCase();
             const found = fileList.find(filename => filename.toUpperCase() === copybookFileWithExtension.toUpperCase())
             if (found) {
-                return new URL(path.join(folder, found));
+                return new urlUtil.URL(path.join(folder, found));
             }
         }
     }
@@ -50,9 +50,11 @@ export function getURIFrom(folder: string, entityName: string, extensions?: stri
  * @param resource represent the file to search within the workspace folder list
  * @return an URI representation of the file or undefined if not found
  */
-export function getURIFromResource(resource: string): URL {
+export function getURIFromResource(resource: string): urlUtil.URL {
     for (const workspaceFolder of SettingsUtils.getWorkspacesURI()) {
-        const uri: URL = new URL(path.join(workspaceFolder, resource));
+        const uri: urlUtil.URL = (path.resolve(resource) === path.normalize(resource))
+            ? urlUtil.pathToFileURL(resource) :
+            new urlUtil.URL(path.normalize(path.join(workspaceFolder, resource)));
         if (fs.existsSync(uri)) {
             return uri;
         }
@@ -70,10 +72,10 @@ export function searchInWorkspace(entityName: string, targetFolders: string[], e
     if (targetFolders) {
         const localFolderList: string[] = targetFolders
             .map(getURIFromResource)
-            .filter((url: URL) => url !== undefined)
-            .map((url: URL) => url.href);
+            .filter((url: urlUtil.URL) => url !== undefined)
+            .map((url: urlUtil.URL) => url.href);
         for (const folder of localFolderList) {
-            let uri: URL = getURIFrom(folder, entityName);
+            let uri: urlUtil.URL = getURIFrom(folder, entityName);
             if (!uri) {
                 uri = getURIFrom(folder, entityName, extensions);
             }