Merge branch 'main' into executeFile

Author: EduardKrieger

.github/workflows/linuxPullRequest.yml

@@ -20,7 +20,7 @@ jobs:
       - name: run checkout.sh
         run: bash checkout.sh
 
-      - name: run buildRun.sh --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }} ${{ github.event.inputs.logLevel }}
+      - name: run buildRun.sh --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }}
         uses: GabrielBB/[email protected]
         with:
-          run: sh buildRun.sh --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }} ${{ github.event.inputs.logLevel }}
+          run: sh buildRun.sh --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }}

.github/workflows/windowsPullRequest.yml

@@ -20,5 +20,6 @@ jobs:
       - name: run checkout.ps1
         run: .\checkout.ps1
 
-      - name: run buildRun.ps1 --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }} ${{ github.event.inputs.logLevel }}
-        run: .\buildRun.ps1 --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }} ${{ github.event.inputs.logLevel }}
+      - name: run buildRun.ps1 --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }}
+        run: .\buildRun.ps1 --user ${{ github.actor }} --branch ${{ github.event.pull_request.head.ref }}
+

documentation/Development.md

@@ -2,11 +2,11 @@
 
 In this section we will describe how you can implement your own tutorials.
 Learn more about the file system and where you can add your commands in 
-https://github.com/devonfw-forge/tutorials/wiki/Structure
+https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure
 
 ### How to create a playbook
 The playbooks for the tutorial-compiler are contained in the tutorials repository. There you will find a description of how to create your own playbook.
-https://github.com/devonfw-forge/tutorials/wiki/Development
+https://github.com/devonfw-tutorials/tutorials/wiki/Development
 
 ### How to create your own command
 To create a new command you can use in your playbooks, you have to implement a new function for this command in all runner class you want to support this command. If you want to use the command only in katacoda tutorials for example, you have to implement the function only in the katacoda runner class.

documentation/Functions.md

@@ -103,7 +103,7 @@ will run "git clone https://github.com/[GitHub-name]/[playbook-name]" and checko
         `'/root/workspaces'`
 
 
-Learn more about the workspace directory and working directory on [Structure](https://github.com/devonfw-forge/tutorial-compiler/wiki/Structure)
+Learn more about the workspace directory and working directory on [Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)
 
         
 ### changeWorkspace
@@ -113,7 +113,7 @@ Learn more about the workspace directory and working directory on [Structure](ht
 changeWorkspace("devonfw/workspaces/project")
 will set the workspace directory to "[working directory]/devonfw/workspaces/project"
 
-Learn more about the workspace directory and working directory on [Structure](https://github.com/devonfw-forge/tutorial-compiler/wiki/Structure)
+Learn more about the workspace directory and working directory on [Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)
 
 ### executeCommand
 #### parameter 
@@ -177,9 +177,10 @@ cobiGenJava("path/to/java/file/MyEntity.java",[1,3,5,6,8])
 
 ### createDevon4jProject
 #### parameter 
-1. The project name
+1. The base package name
 #### example 
-createDevon4jProject("cobigenexample")
+createDevon4jProject("com.mycustomer.myapplication")
+
 
 ***
 
@@ -205,7 +206,7 @@ createFile("cobigenexample/core/src/main/java/com/example/application/cobigenexa
 #### parameter 
 1. Path of the file to be changed (relative path to the workspace directory)
 2. 
- *  Path of the file to get the content from or a string, that should be inserted.
+ *  Path of the file to get the content from or a string, that should be inserted.(relative path to the playbook directory)
  * (Optional) Name of a placeholder 
  * (Optional) Line number where u want to insert your code. (Possible lines are: 1...n+1 for N = number of existing lines. File cant be empty) 
 #### example 
@@ -255,11 +256,11 @@ createFolder("directoryPath/subDirectory")
 1. Path into which the repository is to be cloned, relative to workspace.
 2. Git repository URL
 #### example 
-cloneRepository("", "https://github.com/devonfw-forge/tutorial-compiler.git")
+cloneRepository("", "https://github.com/devonfw-tutorials/tutorial-compiler.git")
 Repository will be cloned directly into the workspace directory.
 
-cloneRepository("devonfw-forge", "https://github.com/devonfw-forge/tutorial-compiler.git")
-Repository will be cloned into a newly created subdirectory devonfw-forge.
+cloneRepository(devonfw-tutorials", "https://github.com/devonfw-tutorials/tutorial-compiler.git")
+Repository will be cloned into a newly created subdirectory devonfw-tutorials.
 
 ***
 
@@ -396,4 +397,13 @@ This command also works if the devonfw IDE is not installed, but then you have t
 2. Path of the script (Windows). Relative to the playbook directory 
 
 #### example
-addSetupScript("assets/createProjectScript.sh", "assets/createProjectScript.ps1")
+addSetupScript("assets/createProjectScript.sh", "assets/createProjectScript.ps1")
+
+***
+
+### openFile
+#### parameter 
+1. Path of the file to be opened (relative path to the workspace directory)
+
+#### example 
+openFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java")

documentation/Home.md

@@ -1,15 +1,15 @@
 **Welcome to the tutorial-compiler wiki!**
 
 To download and setup the tutorial-compiler use the description in the setup section.<br/>
-[Setup](https://github.com/devonfw-forge/tutorial-compiler/wiki/Setup)
+[Setup](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Setup)
 
 If you want to implement your own tutorials the Development section may help you.<br/>
-[Development](https://github.com/devonfw-forge/tutorial-compiler/wiki/Development)
+[Development](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Development)
 
 You find a list of functions which are already implemented in the Functions section.<br/>
-[Functions](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions)
+[Functions](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions)
 
 Learn more about the project structure.<br/>
-[Structure](https://github.com/devonfw-forge/tutorial-compiler/wiki/Structure)
+[Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)
 
 

documentation/Structure.md

@@ -13,7 +13,7 @@
             /--index.asciidoc
 
 Write your own tutorials in "./tutorials/[playbook-name]/index.asciidoc".
-You will find all the details in the tutorials [Developement](https://github.com/devonfw-forge/tutorials/wiki/Development) page.
+You will find all the details in the tutorials [Developement](https://github.com/devonfw-tutorials/tutorials/wiki/Development) page.
 
 
 # File system of the "tutorial-compiler" - repository 
@@ -35,15 +35,15 @@ You will find all the details in the tutorials [Developement](https://github.com
 * wikiEclipse
 * wikiEditor
 
-Create your own commands as shown in tutorial-compilers's [Developement](https://github.com/devonfw-forge/tutorials/wiki/Development) page inside the "./index.ts"-files.
+Create your own commands as shown in tutorial-compilers's [Developement](https://github.com/devonfw-tutorials/tutorials/wiki/Development) page inside the "./index.ts"-files.
 
 ### Assertions 
 
     |--tutorial-compiler
         |--assertions
 
 Add assertions by adding a new class into the "./tutorial-compiler/assertions"-folder 
-Learn more about it in [Development](https://github.com/devonfw-forge/tutorials/wiki/Development)
+Learn more about it in [Development](https://github.com/devonfw-tutorials/tutorials/wiki/Development)
 
 
 ## Katacoda tutorials
@@ -78,8 +78,8 @@ Without the devonfw IDE the workspace directory equals the working directory.
 
     |--[working-directory]
 
-In [Functions](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions) you will find the phrase "relative to workspace", which means relative to the working directory.
-You can set a new workspace with the function [changeWorkspace](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions).
+In [Functions](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions) you will find the phrase "relative to workspace", which means relative to the working directory.
+You can set a new workspace with the function [changeWorkspace](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions).
 
 ### Workspace with devonfw IDE 
 
@@ -89,16 +89,16 @@ You can set a new workspace with the function [changeWorkspace](https://github.c
                 |--main
 
 The functions 
-* [restoreDevonfwIde](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions)
-* [installDevonfwIde](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions)
+* [restoreDevonfwIde](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions)
+* [installDevonfwIde](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions)
 
 will change the workspace to the "[working-directory]/devonfw/workspaces/main".
 The phrase "relative to workspace" means in this case relative to "./main"
-You can set a new workspace with the function [changeWorkspace](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions).
+You can set a new workspace with the function [changeWorkspace](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions).
 
 ### Workspace with restoreWorkspace
 
-The function [restoreWorkspace](https://github.com/devonfw-forge/tutorial-compiler/wiki/Functions) will change the workspace.
+The function [restoreWorkspace](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions) will change the workspace.
 
 #### WIthout devonfw IDE
 

engine/parser.def

@@ -46,7 +46,10 @@ blockmarker "===="
   = "===="
 
 stepstitle
-  = "==" _ string __
+  = "==" _ steptitle __
+  
+steptitle
+  = [^\r\n] + { return { "steptitle": text()};}
 
 steptextlines
   = steptextline* { return { "steptextlines": text()}; }

engine/parser.ts

@@ -52,7 +52,9 @@ export class Parser {
 
     getTitle(parseResult, index) {
         try {
-            return (parseResult[3][index][3][2]|| parseResult[3][index][2][3][2]);
+            // parseResult[3][index][4][2] step without block
+            // parseResult[3][index][2][4][2] step inside a block
+            return (parseResult[3][index][4][2].steptitle || parseResult[3][index][2][4][2].steptitle);
         } catch(error) {
             return null;
         }

engine/run.ts

@@ -2,7 +2,6 @@ import { Parser } from "./parser";
 import { Playbook } from "./playbook";
 import { Environment } from "./environment";
 import { Engine } from "./engine";
-import { isObject } from "util";
 const fs = require('fs');
 const yargs = require('yargs/yargs');
 
@@ -21,6 +20,7 @@ class Run {
             this.parsePlaybooks();
             this.parseEnvironments();
             let entries = this.filterEnv(Array.from(this.environments.entries()));
+
             for (let entry of entries) {
                 let key = entry[0];
                 let value = entry[1];
@@ -46,7 +46,7 @@ class Run {
         }
 
         if (this.errors.length != 0) {
-            console.log("Errors", this.errors);
+            console.log("Errors", JSON.stringify(this.errors, null, "\t"));
         }
         return this.errors.length == 0;
     }

engine/wikiRunner.ts

@@ -11,6 +11,7 @@ export abstract class WikiRunner extends Runner {
     init(playbook: Playbook): void {
         let outputDirectory = this.createFolder(path.join(this.getOutputDirectory(), "wiki", this.environmentName), false)
         this.outputPathTutorial = this.createFolder(path.join(outputDirectory, playbook.name), true);
+        this.setVariable(this.workspaceDirectory, path.join(this.getWorkingDirectory()));
     }
 
     async destroy(playbook: Playbook): Promise<void> {

localBuildRun.ps1

@@ -8,4 +8,4 @@ if(-not $?) { throw 'tests failed' }
 node $PSScriptRoot\build\engine\run.js $args
 if(Test-Path $PSScriptRoot\build\playbooks){
     Remove-Item .\build\playbooks -Recurse -Force
-}
+}

runners/console/consoleUtils.ts

@@ -26,6 +26,7 @@ export class ConsoleUtils {
     static executeCommandAsync(command: string, directory: string, result: RunResult, env: any): child_process.ChildProcess {
         if(result.returnCode != 0) return;
         let process = child_process.spawn(command, [], { shell: true, cwd: directory, env: env });
+
         let output = "";
         process.stdout.on('data', function(data) {
             output += data.toString();

runners/console/index.ts

@@ -168,7 +168,7 @@ export class Console extends Runner {
 
         let workspaceDir = path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main");
         let projectName = runCommand.command.parameters[0];
-        ConsoleUtils.executeDevonCommandSync("java create com.example.application." + projectName, workspaceDir, path.join(this.getWorkingDirectory(), "devonfw"), result, this.env);
+        ConsoleUtils.executeDevonCommandSync("java create " + projectName, workspaceDir, path.join(this.getWorkingDirectory(), "devonfw"), result, this.env);
         return result;
     }
 
@@ -408,7 +408,7 @@ export class Console extends Runner {
     }
 
     runNextKatacodaStep(runCommand: RunCommand): RunResult {
-        //Only needed for katacoda runner
+        //Only needed for katacoda and wiki runner
         return null;
     }
 
@@ -520,6 +520,13 @@ export class Console extends Runner {
 
         return result;
     }
+  
+    runOpenFile(runCommand: RunCommand): RunResult {
+        let result = new RunResult();
+        result.returnCode = 0;
+        //Only needed for katacoda, wiki runner and the assertions
+        return result;
+    }
 
 
     async assertInstallDevonfwIde(runCommand: RunCommand, result: RunResult) {
@@ -606,15 +613,18 @@ export class Console extends Runner {
     async assertCreateDevon4jProject(runCommand: RunCommand, result: RunResult) {
         try {
             let workspaceDir = path.join(this.getWorkingDirectory(), "devonfw", "workspaces", "main");
-
+            let lastDot = runCommand.command.parameters[0].lastIndexOf('.') + 1;
+            let projectFolder = runCommand.command.parameters[0].substr(lastDot);
+            let package2Folder = path.join(runCommand.command.parameters[0].replace(/\./g, path.sep));
+        
             new Assertions()
             .noErrorCode(result)
             .noException(result)
-            .directoryExits(path.join(workspaceDir, runCommand.command.parameters[0]))
-            .directoryExits(path.join(workspaceDir, runCommand.command.parameters[0], "api", "src", "main", "java"))
-            .directoryExits(path.join(workspaceDir, runCommand.command.parameters[0], "core", "src", "main", "java"))
-            .directoryExits(path.join(workspaceDir, runCommand.command.parameters[0], "server", "src", "main", "java"))
-            .fileExits(path.join(workspaceDir, runCommand.command.parameters[0], "core", "src", "main", "java", "com", "example", "application", runCommand.command.parameters[0], "SpringBootApp.java"));
+            .directoryExits(path.join(workspaceDir, projectFolder))
+            .directoryExits(path.join(workspaceDir, projectFolder, "api", "src", "main", "java"))
+            .directoryExits(path.join(workspaceDir, projectFolder, "core", "src", "main", "java"))
+            .directoryExits(path.join(workspaceDir, projectFolder, "server", "src", "main", "java"))
+            .fileExits(path.join(workspaceDir, projectFolder, "core", "src", "main", "java", package2Folder, "SpringBootApp.java"));
         } catch(error) {
             await this.cleanUp();
             throw error;
@@ -864,6 +874,20 @@ export class Console extends Runner {
         }
     }
 
+    async assertOpenFile(runCommand: RunCommand, result: RunResult){
+        try{
+            new Assertions()
+            .noErrorCode(result)
+            .noException(result)
+            .fileExits(path.join(this.getVariable(this.workspaceDirectory), runCommand.command.parameters[0]));
+        }
+        catch(error) {
+            await this.cleanUp();
+            throw error;
+        }
+    }
+
+
     private lookup(obj, lookupkey) {
         for(var key in obj) {