Merge branch 'main' into feature/createproject

Author: denise-khuu

build - Shortcut.lnk

@@ -7,11 +7,12 @@ The following functions are already implemented:
 
 ***
 
-### installDevonIde
+### installDevonfwIde
 #### parameter
 1. The tools you want to install within the devonfw ide: string array
+2. Optional: The version of the ide to install
 #### example
-installDevonfwIde(["java","mvn"])
+installDevonfwIde(["java","mvn"], "2020.08.001")
 
 ***
 
@@ -40,3 +41,12 @@ cobiGenJava("path/to/java/file/MyEntity.java",[1,3,5,6,8])
 createDevon4jProject("cobigenexample")
 
 ***
+
+### buildJava
+#### parameter 
+1. The project directory
+2. Indicator whether tests should be run
+#### example 
+buildJava("cobigenexample", true)
+
+***

documentation/Functions.md

@@ -36,12 +36,16 @@ export class Console extends Runner {
         let installDir = path.join(this.getWorkingDirectory(), "devonfw");
         this.createFolder(installDir, true);
 
+        let downloadUrl = "https://bit.ly/2BCkFa9";
+        if(command.parameters.length > 1 && command.parameters[1] != "") {
+            downloadUrl = "https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.devonfw.tools.ide&a=devonfw-ide-scripts&p=tar.gz&v=" + command.parameters[1];
+        }
         if(this.platform == ConsolePlatform.WINDOWS) {
-            this.executeCommandSync("powershell.exe Invoke-WebRequest -OutFile devonfw.tar.gz https://bit.ly/2BCkFa9", installDir, result);
+            this.executeCommandSync("powershell.exe \"Invoke-WebRequest -OutFile devonfw.tar.gz '" + downloadUrl + "'\"", installDir, result);
             this.executeCommandSync("powershell.exe tar -xvzf devonfw.tar.gz", installDir, result);
             this.executeCommandSync("powershell.exe ./setup " + path.join(settingsDir, "settings.git").replace(/\\/g, "/"), installDir, result, "yes");
         } else {
-            this.executeCommandSync("wget -c https://bit.ly/2BCkFa9 -O - | tar -xz", installDir, result);
+            this.executeCommandSync("wget -c \"" + downloadUrl + "\" -O - | tar -xz", installDir, result);
             this.executeCommandSync("bash setup " + path.join(settingsDir, "settings.git").replace(/\\/g, "/"), installDir, result, "yes");
         }
 
@@ -75,6 +79,20 @@ export class Console extends Runner {
         return result;
     }
 
+    runBuildJava(step: Step, command: Command): RunResult {
+        let result = new RunResult();
+        result.returnCode = 0;
+
+        let projectDir = path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main", command.parameters[0])
+        if(this.platform == ConsolePlatform.WINDOWS) {
+            this.executeCommandSync("devon mvn clean install -Dmaven.test.skip=" + !command.parameters[1], projectDir, result);
+        } else {
+            this.executeCommandSync("~/.devon/devon mvn clean install -Dmaven.test.skip=" + !command.parameters[1], projectDir, result);
+        }
+
+        return result;
+    }
+
     runCobiGenJava(step: Step, command: Command): RunResult {
         return null;
     }
@@ -103,6 +121,17 @@ export class Console extends Runner {
         .fileExits(path.join(this.getWorkingDirectory(), "devonfw", "software", "cobigen-cli", "cobigen"));
     }
 
+    async assertBuildJava(step: Step, command: Command, result: RunResult) {
+        let workspaceDir = path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main");
+
+        new Assertions()
+        .noErrorCode(result)
+        .noException(result)
+        .directoryExits(path.join(workspaceDir, command.parameters[0], "api", "target"))
+        .directoryExits(path.join(workspaceDir, command.parameters[0], "core", "target"))
+        .directoryExits(path.join(workspaceDir, command.parameters[0], "server", "target"));
+    }
+
     async assertCobiGenJava(step: Step, command: Command, result: RunResult) {
         console.log("there is no assertion yet for the cobiGenJava command");
     }
@@ -121,10 +150,11 @@ export class Console extends Runner {
     }
 
 
+
     private executeCommandSync(command: string, directory: string, result: RunResult, input?: string) {
         if(result.returnCode != 0) return;
 
-        let process = child_process.spawnSync(command, { shell: true, cwd: directory, input: input });
+        let process = child_process.spawnSync(command, { shell: true, cwd: directory, input: input, maxBuffer: Infinity });
         if(process.status != 0) {
             console.log("Error executing command: " + command + " (exit code: " + process.status + ")");
             console.log(process.stderr.toString(), process.stdout.toString());

runners/console/index.ts

@@ -138,6 +138,31 @@ export class Katacoda extends Runner {
        return null;  
     }
 
+    runCreateDevon4jProject(step: Step, command: Command): RunResult{
+        return null;
+    }
+
+    runBuildJava(step: Step, command: Command): RunResult{
+        
+        //cdCommand needs to be added
+        let cdCommand = "";
+
+        let skipTestDescr = "";
+        let skipTest = "";
+        
+        if(command.parameters[1] == true){
+            skipTest = '-Dmaven.test.skip=' + command.parameters[1];
+            skipTestDescr = "We do not need to execute the test cases, so we can skip them by using the option '-Dmaven.test.skip=true'."
+        }
+        this.steps.push({
+            "title": "Build the java project",
+            "text": "step" + this.stepsCount + ".md"
+        });
+        this.renderTemplate("buildJava.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter, cdCommand: cdCommand, skipTest: skipTest, skipTestDescr: skipTestDescr});
+        return null;
+
+    }
+
     private renderTemplate(name: string, targetPath: string, variables) {
         let template = fs.readFileSync(path.join(this.getRunnerDirectory(),"templates", name), 'utf8');
         let result = ejs.render(template, variables);

runners/katacoda/index.ts

@@ -0,0 +1,13 @@
+<%= text; %>
+
+<%= cdCommand; %>
+ 
+Use the following devon command to build the java project.
+
+`devon mvn clean install <%= skipTest; %>`{{execute}}
+
+The maven command 'clean' will clear the target directory beforehand. 
+
+<%= skipTestDescr; %>
+
+<%= textAfter; %>