Merge pull request #32 from denise-khuu/feature/createproject

maybeec · web-flow · commit cc99151f16b0 · 2020-12-09T12:12:31.000+01:00
Feature/createproject
diff --git a/buildRun.ps1 b/buildRun.ps1
@@ -3,4 +3,5 @@ Copy-Item -Force -Recurse -Path $PSScriptRoot\engine\parser.def -Destination $PS
 Copy-Item -Force -Recurse -Path $PSScriptRoot\playbooks\ -Destination $PSScriptRoot\build
 Copy-Item -Force -Recurse -Path $PSScriptRoot\environments\ -Destination $PSScriptRoot\build
 Copy-Item -Force -Recurse -Path $PSScriptRoot\runners\ -Destination $PSScriptRoot\build
+npm test
 node $PSScriptRoot\build\engine\run.js
diff --git a/buildRun.sh b/buildRun.sh
@@ -3,4 +3,5 @@ cp engine/parser.def build/engine/parser.def
 cp -r playbooks build
 cp -r environments build
 cp -r runners build
+npm test
 node build/engine/run.js
diff --git a/localBuildRun.ps1 b/localBuildRun.ps1
@@ -3,4 +3,6 @@ Copy-Item -Force -Recurse -Path $PSScriptRoot\engine\parser.def -Destination $PS
 Copy-Item -Force -Recurse -Path $PSScriptRoot\..\tutorials -Destination $PSScriptRoot\build\playbooks
 Copy-Item -Force -Recurse -Path $PSScriptRoot\environments\ -Destination $PSScriptRoot\build
 Copy-Item -Force -Recurse -Path $PSScriptRoot\runners\ -Destination $PSScriptRoot\build
+npm test
+if(-not $?) { throw 'tests failed' } 
 node $PSScriptRoot\build\engine\run.js
diff --git a/localBuildRun.sh b/localBuildRun.sh
@@ -3,4 +3,9 @@ cp engine/parser.def build/engine/parser.def
 cp -r ../tutorials build/playbooks
 cp -r environments build
 cp -r runners build
+npm test
+if [ $? -eq 1 ]; then 
+    echo 'tests failed' 
+    exit 1
+fi
 node build/engine/run.js
diff --git a/localBuildTest.ps1 b/localBuildTest.ps1
@@ -0,0 +1,3 @@
+tsc
+npm test
+if(-not $?){ throw 'tests failed' } 
diff --git a/localBuildTest.sh b/localBuildTest.sh
@@ -0,0 +1,6 @@
+tsc
+npm test
+if [ $? -eq 1 ]; then 
+    echo 'tests failed' 
+    exit 1
+fi
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -11,9 +11,12 @@
     "ts-pegjs": "^0.2.7",
     "yargs": "^16.1.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@types/jasmine": "^3.6.2",
+    "jasmine": "^3.6.2"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "npx jasmine"
   },
   "author": "",
   "license": "ISC"
diff --git a/runners/console/index.ts b/runners/console/index.ts
@@ -97,10 +97,6 @@ export class Console extends Runner {
         return null;
     }
 
-    runBuildJava(step: Step, command: Command): RunResult {
-        return null;
-    }
-
     async assertInstallDevonfwIde(step: Step, command: Command, result: RunResult) {
         let installedTools = command.parameters[0];
 
@@ -153,9 +149,6 @@ export class Console extends Runner {
         .fileExits(path.join(workspaceDir, command.parameters[0], "core", "src", "main", "java", "com", "example", "application", command.parameters[0], "SpringBootApp.java"));
     }
 
-    async assertbuildJava(step: Step, command: Command, result: RunResult) {
-        console.log("assertbuildJava exceptions");
-    }
 
 
     private executeCommandSync(command: string, directory: string, result: RunResult, input?: string) {
diff --git a/runners/katacoda/dirUtils.ts b/runners/katacoda/dirUtils.ts
@@ -0,0 +1,51 @@
+import * as path from 'path';
+
+export class DirUtils{
+
+    getCdParam(currentDir:string, targetDir:string):string{
+        
+        //returns an empty string, if both variables have the same path 
+        if(currentDir == targetDir){
+            return "";
+        }
+             
+        let dirPath = "";
+
+        let currentPaths = currentDir.split(path.sep);
+        let targetPaths = targetDir.split(path.sep);
+        
+        let index;
+        let isEqual = true;
+         
+        //saves the remaining path, if currentdir is the prefix of targetDir
+        if(targetDir.substring(0,currentDir.length) == currentDir){
+            return path.join(targetDir.replace(currentDir + path.sep, '')).replace("\\", "/");
+        }
+
+
+        else{
+            //returns the absolut directory, if the first parent folder is different
+            if(currentPaths[1] != targetPaths[1]){
+                return targetDir.replace("\\", "/");
+            }
+            
+            //iterates throught currentPath array to compare parent directories
+            currentPaths.forEach((currentPath, i) => {
+                if(currentPath == targetPaths[i] && isEqual == true){
+                    index = i;
+                }else{
+                    isEqual = false;
+                    dirPath = path.join(dirPath,'..');
+                }
+            })
+
+            //slice targetPaths to get the relative path
+            targetPaths = targetPaths.slice(index + 1, targetPaths.length);
+        
+            return path.join(dirPath, targetPaths.join(path.sep)).replace("\\", "/");
+            
+        }
+
+    }
+
+}
diff --git a/runners/katacoda/index.ts b/runners/katacoda/index.ts
@@ -6,6 +6,7 @@ import { Command } from "../../engine/command";
 import { KatacodaTools } from "./katacodaTools";
 import { KatacodaStep, KatacodaSetupScript } from "./katacodaInterfaces";
 import { KatacodaAssetManager } from "./katacodaAssetManager";
+import { DirUtils } from "./dirUtils";
 import * as path from 'path';
 import * as ejs from 'ejs';
 import * as fs from 'fs';
@@ -20,7 +21,8 @@ export class Katacoda extends Runner {
     private setupScripts: KatacodaSetupScript[] = [];
     private assetManager: KatacodaAssetManager;
     private setupDir: string;
-
+    private currentDir: string = "/root";
+ 
     init(playbook: Playbook): void {
         // create directory for katacoda tutorials if not exist
         this.createFolder(path.join(this.getOutputDirectory(), "katacoda/"), false)
@@ -66,6 +68,8 @@ export class Katacoda extends Runner {
     }
 
     runInstallDevonfwIde(step: Step, command: Command): RunResult {
+        let cdCommand = this.changeCurrentDir("/root");     
+
         let tools = command.parameters[0].join(" ").replace(/vscode/,"").replace(/eclipse/, "").trim();
 
         // create script to download devonfw ide settings
@@ -81,7 +85,11 @@ export class Katacoda extends Runner {
             "title": "Install devonfw IDE",
             "text": "step" + this.stepsCount + ".md",
         });
-        this.renderTemplate("installDevonfwIde.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter });
+        this.renderTemplate("installDevonfwIde.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter, cdCommand: cdCommand});
+        
+        //update current directory
+        this.currentDir = path.join(this.currentDir, "devonfw");
+        
         return null;
     }
 
@@ -90,7 +98,7 @@ export class Katacoda extends Runner {
             "title": "Install CobiGen",
             "text": "step" + this.stepsCount + ".md"
         });
-        this.renderTemplate("installCobiGen.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter });
+        this.renderTemplate("installCobiGen.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter});
         return null;
     }
 
@@ -110,6 +118,24 @@ export class Katacoda extends Runner {
         });
         this.renderTemplate("cobiGenJava.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter, javaFile: params[0], cobiGenTemplates: cobiGenTemplates });
         return null;
+
+    }
+
+    runCreateDevon4jProject(step: Step, command:Command): RunResult {
+
+        // generate template to change directory, if the current directory is not equal to the required start directory
+       let cdCommand = this.changeCurrentDir(path.join("/root", "devonfw"));
+
+       this.steps.push({
+           "title": "Create a new project",
+           "text": "step" + this.stepsCount + ".md"
+       });
+
+        //update current directory
+       this.currentDir = path.join(this.currentDir, "workspace", "main"); 
+
+       this.renderTemplate("createDevon4jProject.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter, cdCommand: cdCommand, name : command.parameters[0]});
+       return null;  
     }
 
     runCreateDevon4jProject(step: Step, command: Command): RunResult{
@@ -153,4 +179,20 @@ export class Katacoda extends Runner {
 
         this.assetManager.registerFile(setupFile, "setup/setup.txt", "/root/setup", false);
     }
+
+    private changeCurrentDir(targetDir:string):string{
+        if(this.currentDir == targetDir){
+            return "";
+        }
+        let dirUtils = new DirUtils();
+        let dir = dirUtils.getCdParam(this.currentDir, targetDir);
+
+        this.currentDir = targetDir; 
+
+        //create template to change directory 
+        let template = fs.readFileSync(path.join(this.getRunnerDirectory(),"templates", 'cd.md'), 'utf8');
+        return ejs.render(template, {dir: dir}); 
+    }
+
+
 }
diff --git a/runners/katacoda/templates/cd.md b/runners/katacoda/templates/cd.md
@@ -0,0 +1,4 @@
+
+Please change the folder to <%= dir; %>
+
+`cd <%= dir; %>`{{execute}}
diff --git a/runners/katacoda/templates/createDevon4jProject.md b/runners/katacoda/templates/createDevon4jProject.md
@@ -0,0 +1,13 @@
+<%= text; %>
+
+## Setting up your java project
+
+<%= cdCommand; %>
+
+Navigate to the 'workspaces/main/' folder in your devonfw installation directory. 
+`cd workspaces/main`{{execute}}
+
+Now you can use devonfw to setup a java project for you by executing the following devon command.
+`devon java create com.example.application.<%= name; %>`{{execute}}
+
+<%= textAfter; %>
diff --git a/runners/katacoda/templates/installDevonfwIde.md b/runners/katacoda/templates/installDevonfwIde.md
@@ -2,6 +2,8 @@
 
 ## devonfw setup
 
+<%= cdCommand; %>
+
 Create the directory where the devonfw ide will be installed.
 
 `mkdir devonfw`{{execute}}
diff --git a/spec/runners/katacoda/dirUtilsSpec.ts b/spec/runners/katacoda/dirUtilsSpec.ts
@@ -0,0 +1,25 @@
+import 'jasmine';
+import * as path from 'path';
+import { DirUtils } from '../../../runners/katacoda/dirUtils';
+
+describe("DirUtils", () => {
+  let target = new DirUtils();
+  describe("changeCurrentDir", () => {
+    it("is already in the right folder", () => {
+      expect(target.getCdParam(path.join('/root'), path.join('/root'))).toBe('');
+    });
+    it("changes directly to the child folder, because currentDir is the prefix of dir", () => {
+      expect(target.getCdParam(path.join('/root/devonfw'), path.join('/root/devonfw/setup'))).toBe(path.join('setup').replace("\\", "/"));
+    });
+    it("returns an absolute path, because both dirs don't have matching parent folders", () => {
+      expect(target.getCdParam(path.join('/setup'), path.join('/root/devonfw/setup'))).toBe(path.join('/root/devonfw/setup').replace("\\", "/"));
+    });
+    it("changes to parent folder before changing to child folder", () => {
+      expect(target.getCdParam(path.join('/root/devonfw'), path.join('/root/setup/folder0/folder1'))).toBe(path.join('../setup/folder0/folder1').replace("\\", "/"));
+    });
+    it("changes to parent folder before changing to child folder and one child folder has the same position and name", () => {
+      expect(target.getCdParam(path.join('/root/devonfw/folder/setup'), path.join('/root/devonfw/setup/setup'))).toBe(path.join('../../setup/setup').replace("\\", "/"));
+    });
+
+  });
+});
diff --git a/spec/support/jasmine.json b/spec/support/jasmine.json
@@ -0,0 +1,11 @@
+{
+  "spec_dir": "build/spec",
+  "spec_files": [
+    "**/*[sS]pec.js"
+  ],
+  "helpers": [
+    "helpers/**/*.js"
+  ],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+tsc`
	`2`	`+npm test`
	`3`	`+if(-not $?){ throw 'tests failed' }`