Refactor File-watcher projectName, add subdir to location when available

Signed-off-by: James Wallis <james.wallis1@ibm.com>

Author: James Wallis

src/pfe/file-watcher/server/src/controllers/projectsController.ts

@@ -146,7 +146,7 @@ export async function createProject(req: ICreateProjectParams): Promise<ICreateP
         return { "statusCode": 400, "error": { "msg": "projectID, projectType and location are required parameters" }};
     }
 
-    const projectName = projectLocation.split("/").pop();
+    const projectName = projectUtil.getProjectNameFromPath(projectLocation);
 
     // create log storing directory for the project
     logger.logInfo("Creating project logs directory");
@@ -658,7 +658,7 @@ export async function deleteProject(projectID: string): Promise<IDeleteProjectSu
 
         const projectInfo: ProjectInfo = await getProjectInfoFromFile(projectMetadata.infoFile);
         const projectLocation = projectInfo.location;
-        const projectName = projectLocation.split("/").pop();
+        const projectName = projectUtil.getProjectNameFromPath(projectLocation);
 
         logger.logProjectTrace("Retrieved project information for project " + projectMetadata.infoFile, projectID);
         logger.logProjectTrace(JSON.stringify(projectInfo), projectID);
@@ -842,7 +842,7 @@ export async function projectDeletion(projectID: string): Promise<number> {
         const projectMetadata = getProjectMetadataById(projectID);
         const projectInfo: ProjectInfo = await getProjectInfoFromFile(projectMetadata.infoFile);
         const projectLocation = projectInfo.location;
-        const projectName = projectLocation.split("/").pop();
+        const projectName = projectUtil.getProjectNameFromPath(projectLocation);
 
         logger.logProjectTrace("Retrieved project information for project " + projectMetadata.infoFile, projectID);
         logger.logProjectTrace(JSON.stringify(projectInfo), projectID);
@@ -1154,7 +1154,7 @@ export function saveProjectInfo(projectID: string, projectInfo: ProjectInfo, sav
         const projectJSON = JSON.stringify(projectInfo);
         const infoFile = getProjectMetadataById(projectID).infoFile;
         projectInfoCache[infoFile] = projectJSON;
-        const projectName = projectInfo.location.split("/").pop();
+        const projectName = projectUtil.getProjectNameFromPath(projectInfo.location);
         logger.logProjectTrace(JSON.stringify(projectInfoCache), projectID);
         if (saveIntoJsonFile) {
             fs.writeFile(infoFile, projectJSON, "utf8", (err) => {

src/pfe/file-watcher/server/src/projects/Validator.ts

@@ -14,6 +14,7 @@ import * as io from "../utils/socket";
 import * as locale from "../utils/locale";
 import * as logger from "../utils/logger";
 import { Operation } from "./operation";
+import { getProjectNameFromPath } from "./projectUtil";
 
 /**
  * @class
@@ -57,7 +58,7 @@ export class Validator {
     async validateRequiredFiles (requiredFiles: string[]): Promise<void> {
         if (requiredFiles) {
             const projectID = this.projectID;
-            const projectName = this.location.split("/").pop();
+            const projectName = getProjectNameFromPath(this.location);
             const OR_SPLIT = "|";
 
             try {
@@ -179,7 +180,7 @@ export class Validator {
      */
     sendResult(): void {
         const projectID = this.projectID;
-        const projectName = this.location.split("/").pop();
+        const projectName = getProjectNameFromPath(this.location);
         logger.logProjectInfo("Sending validation result", projectID, projectName);
         io.emitOnListener("projectValidated", this.result());
     }

src/pfe/file-watcher/server/src/projects/actions.ts

@@ -57,7 +57,7 @@ export const validate = async function(args: IProjectActionParams): Promise<{ op
         "projectType": projectType,
         "location": location
     } as ProjectInfo;
-    const projectName = location.split("/").pop();
+    const projectName = projectUtil.getProjectNameFromPath(location);
     if (args.extensionID) {
         projectInfo.extensionID = args.extensionID;
     }
@@ -131,7 +131,7 @@ export const enableautobuild = async function (args: IProjectActionParams): Prom
 async function enableAndBuild(projectInfo: ProjectInfo): Promise<void> {
     const projectHandler = await projectExtensions.getProjectHandler(projectInfo);
     const projectID = projectInfo.projectID;
-    const projectName = projectInfo.location.split("/").pop();
+    const projectName = projectUtil.getProjectNameFromPath(projectInfo.location);
 
     if (projectHandler.hasOwnProperty("setAutoBuild")) {
         const operation = new Operation("enableautobuild", projectInfo);

src/pfe/file-watcher/server/src/projects/projectUtil.ts

@@ -104,7 +104,7 @@ export async function containerCreate(operation: Operation, script: string, comm
     const event = "projectCreation";
     const projectLocation = operation.projectInfo.location;
     const projectID = operation.projectInfo.projectID;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
     const projectType = operation.projectInfo.projectType;
     if (projectList.indexOf(projectID) === -1)
         projectList.push(projectID);
@@ -173,6 +173,7 @@ export async function containerCreate(operation: Operation, script: string, comm
                 (operation.projectInfo.forceAction) ? String(operation.projectInfo.forceAction) : "NONE", logDir, imagePushRegistry, userMavenSettings];
         } else if (["odo", "odo-devfile"].includes(projectType)) {
             const componentName: string = await getComponentName(projectName);
+            const logDir: string = await logHelper.getLogDir(projectID, projectName);
 
             args = [
                 projectLocation,
@@ -211,7 +212,7 @@ export async function containerUpdate(operation: Operation, script: string, comm
 
     const projectLocation = operation.projectInfo.location;
     const projectID = operation.projectInfo.projectID;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
     const projectType = operation.projectInfo.projectType;
     logger.logProjectInfo("Updating container for " + operation.projectInfo.projectType + " project " + projectLocation, projectID, projectName);
     operation.containerName = await getContainerName(operation.projectInfo);
@@ -280,6 +281,7 @@ export async function containerUpdate(operation: Operation, script: string, comm
             (operation.projectInfo.forceAction) ? String(operation.projectInfo.forceAction) : "NONE", logDir, imagePushRegistry, userMavenSettings];
     } else if (["odo", "odo-devfile"].includes(projectType)) {
         const componentName: string = await getComponentName(projectName);
+        const logDir: string = await logHelper.getLogDir(projectID, projectName);
 
         args = [
             projectLocation,
@@ -316,7 +318,7 @@ export async function containerUpdate(operation: Operation, script: string, comm
 async function executeBuildScript(operation: Operation, script: string, args: Array<string>, event: string): Promise<void> {
     const projectID = operation.projectInfo.projectID;
     const projectLocation = operation.projectInfo.location;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
     const projectInfo = {
         operationId: operation.operationId,
         projectID: operation.projectInfo.projectID
@@ -612,7 +614,7 @@ export async function getProjectMavenSettings(projectInfo: ProjectInfo): Promise
 export async function getProjectLogs(projectInfo: ProjectInfo): Promise<ProjectLog> {
     const projectID = projectInfo.projectID;
     const projectLocation = projectInfo.location;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
     const projectType = projectInfo.projectType;
     const projectLogDir = await logHelper.getLogDir(projectID, projectName);
     const logDirectory = path.join(projectConstants.projectsLogDir, projectLogDir);
@@ -655,7 +657,7 @@ export async function getProjectLogs(projectInfo: ProjectInfo): Promise<ProjectL
 export async function containerDelete(projectInfo: ProjectInfo, script: string): Promise<void> {
 
     const projectID = projectInfo.projectID;
-    const projectName = projectInfo.location.split("/").pop();
+    const projectName = getProjectNameFromPath(projectInfo.location);
     const containerName = await getContainerName(projectInfo);
     const imagePushRegistry = projectInfo.deploymentRegistry;
     logger.logProjectInfo("containerDelete: Kill running processes and remove container... ", projectID, projectName);
@@ -725,7 +727,7 @@ export function getLogName(projectID: string, projectLocation: string): string {
     const hash = crypto.createHash("sha1", <TransformOptions>"utf8").update(projectLocation);
 
     let logName = projectConstants.containerPrefix + projectID + "-" + hash.digest("hex");
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
 
     if (process.env.IN_K8 === "true" && logName.length > 53) {
         logName = logName.substring(0, 53);
@@ -1255,6 +1257,7 @@ export async function runScript(projectInfo: ProjectInfo, script: string, comman
 
     if (["odo", "odo-devfile"].includes(projectInfo.projectType)) {
         const componentName: string = await getComponentName(projectName);
+        const logDir: string = await logHelper.getLogDir(projectID, projectName);
 
         args = [
             projectInfo.location,
@@ -1290,7 +1293,7 @@ export async function buildAndRun(operation: Operation, command: string): Promis
 
     const projectLocation = operation.projectInfo.location;
     const projectID = operation.projectInfo.projectID;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
 
     if (projectList.indexOf(projectID) === -1)
         projectList.push(projectID);
@@ -1446,7 +1449,7 @@ export async function buildAndRun(operation: Operation, command: string): Promis
  */
 async function containerBuildAndRun(event: string, buildInfo: BuildRequest, operation: Operation): Promise<void> {
     const normalizedProjectLocation = path.resolve(buildInfo.projectLocation);
-    const projectName = normalizedProjectLocation.split("/").reverse()[0];
+    const projectName = getProjectNameFromPath(normalizedProjectLocation);
     const logDir = await logHelper.getLogDir(buildInfo.projectID, projectName);
     const dockerBuildLog = path.resolve(buildInfo.projectLocation + "/../.logs/" + logDir, logHelper.buildLogs.dockerBuild + logHelper.logExtension);
     if (process.env.IN_K8 === "true") {
@@ -1668,7 +1671,7 @@ async function containerBuildAndRun(event: string, buildInfo: BuildRequest, oper
  */
 async function runLocalContainer(buildInfo: BuildRequest): Promise<void> {
     const normalizedProjectLocation = path.resolve(buildInfo.projectLocation);
-    const projectName = normalizedProjectLocation.split("/").reverse()[0];
+    const projectName = getProjectNameFromPath(normalizedProjectLocation);
     const logDir = await logHelper.getLogDir(buildInfo.projectID, projectName);
     const appLog = path.resolve(buildInfo.projectLocation + "/../.logs/" + logDir, logHelper.appLogs.app + logHelper.logExtension);
     try {
@@ -1799,7 +1802,7 @@ export async function isApplicationPodUp(buildInfo: BuildRequest, projectName: s
 export async function removeProject(projectInfo: ProjectInfo): Promise<void> {
 
     const projectID = projectInfo.projectID;
-    const projectName = projectInfo.location.split("/").pop();
+    const projectName = getProjectNameFromPath(projectInfo.location);
     const containerName = await getContainerName(projectInfo);
     logger.logProjectInfo("removeProject: Kill running processes and remove container... ", projectID, projectName);
     logger.logProjectInfo("Project ID:        " + projectInfo.projectID, projectID, projectName);
@@ -1903,7 +1906,7 @@ async function getPODInfoAndSendToPortal(operation: Operation, event: string = "
     const projectInfo = operation.projectInfo;
     const projectLocation = projectInfo.location;
     const projectID = projectInfo.projectID;
-    const projectName = projectLocation.split("/").pop();
+    const projectName = getProjectNameFromPath(projectLocation);
     const keyValuePair: UpdateProjectInfoPair = {
         key: "buildRequest",
         value: false
@@ -2203,8 +2206,26 @@ export async function updateDetailedAppStatus(projectID: string, ip: string, por
 export async function exposeOverIngress(projectInfo: ProjectInfo, appPort?: number): Promise<void> {
     if (process.env.IN_K8) {
         const projectID = projectInfo.projectID;
-        const projectName = projectInfo.location.split("/").pop();
+        const projectName = getProjectNameFromPath(projectInfo.location);
         projectInfo.appBaseURL = await kubeutil.exposeOverIngress(projectID, projectName, projectInfo.isHttps, appPort, projectInfo.appBaseURL);
         await projectsController.saveProjectInfo(projectID, projectInfo, true);
     }
 }
+
+/**
+ * Get the projectName from a path
+ *
+ * @param location The project's location
+ */
+export function getProjectNameFromPath(location: string): string {
+    const splitPaths = location.split("/");
+    const cwIndex = splitPaths.indexOf("codewind-workspace");
+    if (cwIndex === -1) {
+        logger.logError("Unable to get project name from path: codewind-workspace isn't in the path");
+        // Fall back to old method if codewind-workspace isn't in the path
+        return splitPaths.pop();
+    }
+    // Project name is the directory after codewind-workspace
+    const projectName = splitPaths[cwIndex + 1];
+    return projectName;
+}

src/pfe/file-watcher/server/src/utils/logger.ts

@@ -15,6 +15,7 @@ import * as path from "path";
 import { promisify } from "util";
 import * as constants from "../projects/constants";
 import * as stackTrace from "stack-trace";
+import { getProjectNameFromPath } from "../projects/projectUtil";
 const chalk = require("chalk"); // tslint:disable-line:no-require-imports
 
 const GENERAL_LOG_FILE_NAME = "Turbine.log";
@@ -101,7 +102,7 @@ export async function getProjectNameByProjectID(projectID: string): Promise<stri
     const data = await readFileAsync(projectDataFile, "utf8");
     const projectData = JSON.parse(data);
     const location = projectData.location;
-    const projectName = location.split("/").pop();
+    const projectName = getProjectNameFromPath(location);
     return projectName;
 }
 

src/pfe/file-watcher/server/test/unit-test/tests/projectUtil.module.test.ts

@@ -449,4 +449,35 @@ export function projectUtilTestModule(): void {
             });
         }
     });
-}
+
+    describe.only("getProjectNameFromPath", () => {
+        const tests = [
+            {
+                title: "should return 'projectName' when it's the directory after 'codewind-workspace'",
+                path: '/codewind-workspace/projectName',
+                want: 'projectName',
+            },
+            {
+                title: "should return 'projectName' when the path is normalized",
+                path: path.resolve('/codewind-workspace/projectName'),
+                want: 'projectName',
+            },
+            {
+                title: "should return 'projectName' when subdirectories are given",
+                path: path.resolve('/codewind-workspace/projectName/templates/default'),
+                want: 'projectName',
+            },
+            {
+                title: "returns 'finalDir' as 'codewind-workspace' isn't in the path",
+                path: path.resolve('/projectName/templates/default/finalDir'),
+                want: 'finalDir',
+            },
+        ];
+        tests.forEach(({ title, path, want }) => {
+            it(`should return '${want}' when the input is '${path}'`, () => {
+                const got = projectUtil.getProjectNameFromPath(path);
+                expect(got).to.equal(want);
+            });
+        });
+    });
+}

src/pfe/portal/modules/FileWatcher.js

@@ -736,7 +736,11 @@ function createProjectActionForBuildAndRun(project, settings) {
     autoBuild,
     ports,
   } = project;
-  const location = project.projectPath();
+
+  let location = project.projectPath();
+  if (extension && extension.projectSubDirectory) {
+    location = path.join(location, extension.projectSubDirectory);
+  }
 
   const projectAction = {
     projectID,

src/pfe/portal/modules/Templates.js

@@ -326,7 +326,7 @@ async function constructRepositoryObject(url, description, name, isRepoProtected
   }
   if (gitCredentials) {
     if (gitCredentials.username) {
-      repository.authentication = { username: gitCredentials.username }; 
+      repository.authentication = { username: gitCredentials.username };
     } else if (gitCredentials.personalAccessToken) {
       repository.authentication = {};
     }
@@ -503,6 +503,9 @@ async function getTemplatesFromRepo(repository, gitCredentials) {
     if (summary.projectStyle) {
       template.projectStyle = summary.projectStyle;
     }
+    if (summary.subDirectory || summary.subDirectory === "") {
+      template.subDirectory = summary.subDirectory;
+    }
     if (repository.name) {
       template.source = repository.name;
     }