Merge branch 'main' into feature/wikiRunnerCreateFile

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/xvfb-action@v1.0
         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/syncDocs.yml

@@ -0,0 +1,80 @@
+env:
+  BUILD_USER: ${{ secrets.BUILD_USER }}
+  BUILD_USER_PASSWD: ${{ secrets.BUILD_USER_PASSWD }}
+  BUILD_USER_EMAIL:  ${{ secrets.BUILD_USER_EMAIL }}
+on:
+  push:
+    branches:
+      - main
+name: Sync Docs
+jobs:
+  update-wiki:
+    if: ${{github.repository == 'devonfw-tutorials/tutorial-compiler'}}
+    runs-on: ubuntu-latest
+    steps:
+      - name: setup variables
+        run: |
+          echo "ORG=$(echo '${{ github.repository }}' | awk -F '/' '{print $1}')" >> $GITHUB_ENV
+          echo "REPO_COMPILER_SOURCE=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
+          echo "REPO_COMPILER_DEST=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}').wiki" >> $GITHUB_ENV
+          echo "REPO_TUTORIAL_DEST=$(echo 'tutorials.wiki')" >> $GITHUB_ENV
+        shell: bash
+      - name: Checkout ${REPO_COMPILER_SOURCE} Repository
+        run: git clone https://github.com/${ORG}/${REPO_COMPILER_SOURCE}.git ${REPO_COMPILER_SOURCE}
+      - name: Checkout ${REPO_COMPILER_DEST} Repository
+        run: git clone https://github.com/${ORG}/${REPO_COMPILER_DEST}.git ${REPO_COMPILER_DEST}
+      - name: Checkout ${REPO_TUTORIAL_DEST} Repository
+        run: git clone https://github.com/${ORG}/${REPO_TUTORIAL_DEST}.git ${REPO_TUTORIAL_DEST}
+      - name: Copy docs and consolidate links
+        run: |
+          cp -rf ${REPO_COMPILER_SOURCE}/documentation/* ${REPO_COMPILER_DEST}/
+          cd ${REPO_COMPILER_DEST}
+          grep -lr "link:[a-zA-Z0-9_.-]*.md.*" .| xargs -r sed -i "s/.md//g"
+          echo ">"
+          git diff-index --quiet HEAD & git status -s
+          echo "<"
+          git status
+          echo ">"
+          git diff-index --quiet HEAD & git status -s
+          echo "<"
+          echo "TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
+          echo "$TO_BE_CANCELLED"
+      - name: Copy docs and consolidate links to ${REPO_TUTORIAL_DEST} Repository
+        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        run: |
+          cp -rf ${REPO_COMPILER_SOURCE}/documentation/* ${REPO_TUTORIAL_DEST}/
+          cd ${REPO_TUTORIAL_DEST}
+          grep -lr "link:[a-zA-Z0-9_.-]*.md.*" .| xargs -r sed -i "s/.md//g"
+          echo ">"
+          git diff-index --quiet HEAD & git status -s
+          echo "<"
+          git status
+          echo ">"
+          git diff-index --quiet HEAD & git status -s
+          echo "<"
+          echo "TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
+          echo "$TO_BE_CANCELLED"
+      - name: setup git user
+        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        run: |
+          git config --global user.email ${BUILD_USER_EMAIL}
+          git config --global user.name ${BUILD_USER}
+      - name: Sync Wiki
+        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        run: |
+          cd ${REPO_COMPILER_DEST}
+          git status
+          git add .
+          git commit -m "${REPO_COMPILER_SOURCE} documentation | GitHub Actions $GITHUB_WORKFLOW $GITHUB_RUN_NUMBER"
+          git remote add origin-wiki "https://${BUILD_USER}:${BUILD_USER_PASSWD}@github.com/${ORG}/${REPO_COMPILER_DEST}.git"
+          git push origin-wiki main
+      - name: Sync Wiki ${REPO_TUTORIAL_DEST} Repository
+        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        run: |
+          cd ${REPO_TUTORIAL_DEST}
+          git status
+          git add .
+          git commit -m "${REPO_COMPILER_SOURCE} documentation | GitHub Actions $GITHUB_WORKFLOW $GITHUB_RUN_NUMBER"
+          git remote add origin-wiki "https://${BUILD_USER}:${BUILD_USER_PASSWD}@github.com/${ORG}/${REPO_TUTORIAL_DEST}.git"
+          git push origin-wiki main
+      

.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 }}
+

assertions/serverIsReachable.ts

@@ -8,10 +8,8 @@ export class ServerIsReachable {
         let interval = this.getValue(parameters, 'intervall', 5);
         let startupTime = this.getValue(parameters, 'startupTime', 600);
         let command = this.getValue(parameters, 'command', "");
-
         if(!port) {
             throw new Error("Missing arguments for the command " + command + ". You have to specify a port for the server. For further information read the function documentation.");
-
         } else {
             let timeoutFlag = false;
             let reached = false;
@@ -45,4 +43,4 @@ export class ServerIsReachable {
     private static sleep(seconds: number) {
         return new Promise(resolve => setTimeout(resolve, seconds * 1000));
     }
-}
+}

documentation/Functions.md

@@ -4,6 +4,7 @@ The following functions are already implemented:
 * restoreDevonfwIde
 * restoreWorkspace
 * changeWorkspace
+* executeCommand
 * installCobiGen
 * cobiGenJava
 * createDevon4jProject
@@ -114,6 +115,39 @@ will set the workspace directory to "[working directory]/devonfw/workspaces/proj
 
 Learn more about the workspace directory and working directory on [Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)
 
+### executeCommand
+#### parameter 
+1. The command that will be executed on Windows
+2. The command that will be executed on Linux
+3. Json-object with optional fields
+   * (Optional) Directory where the command will be executed, if not in current directory (relative to workspace){"dir": string}
+   * (Optional) Synchronous or asynchronous process. Use asynchronous when starting a server. Default is synchronous. {"asynchronous": boolean}
+   * (Optional) Array of arguments {"args": string[]}
+4. Assert information needed if you start a server to check server availability. Only required when you start a asynchronous server. 
+
+#### Commands
+It is needed to pass a command for Windows and also for Linux-based systems because both systems will always be tested.
+
+##### Assertion information
+startupTime = Time in seconds to wait before checking if the server is running
+port: Port on which the server is running
+path: The URL path on which is checked if the server is running
+interval: The availability of the server is checked in the given interval
+* (Required) port: will throw error if no port is given.
+* (Optional) path: subpath which should be pinged, i.e: if localhost:8081/jumpthequeue should be checked path should be "jumpthequeue". DEFAULT: ""
+* (Optional) interval: interval in seconds in which the server should be pinged until it is available or timeouted. DEFAULT: 5 seconds
+* (Optional) startupTime: seconds until a timeout will occur and an error will be thrown. DEFAULT: 10 minutes
+
+#### example
+
+executeCommand("node", "node" ,{"args": ["-v"]})
+Will create a command for executing node -v .
+
+executeCommand("somePollingScript.ps1","bash somePollingScript.sh", {"dir": "data/setup","asynchronous": true, "args": ["--params 5"]})
+Will create a command to execute the script in the directory with the parameter --params 5 and in a new terminal.
+
+executeCommand("someServerScript.ps1","bash someServerScript.sh", {"asynchronous": true, "args":["-port 8080"] },{"port":8080 , "startupTime": 20, "path": "some/path/", "interval": 2})
+Starting a server in a new terminal. You have to specify the port for testing, the other parameters are optional. The startupTime can specify how long the runner will wait for a response from the server process and with interval you can set the frequenzy for the server testing. The path is the subpath from your server that should be reached.
 
 
 ### installCobiGen
@@ -193,12 +227,14 @@ example:{...,"placeholder": "private int age;"}
 | --- | --- | --- |
 |<p>private int age;<br><br>public String getFirstname() {<br>return firstname;<br>}<br></p>|<p>private int age;<br><br>private String company;<br>public String getCompany() {<br>return firstname;<br>}<br>public void setCompany(String company) {<br>this.company = company;<br>}</p>|<p>private int age;<br><br>private String company;<br>public String getCompany() {<br>return firstname;<br>}<br>public void setCompany(String company) {<br>this.company = company;<br><br>public String getFirstname() {<br>return firstname;<br>}<br></p>|
 
+
 ##### Prerequisite
 The usage of the line number function requires having VSCode installed on your System. Not having VSCode installed will not create any output for Katacoda.
 
 ##### Name of the placeholder
 If you want to insert content into your code between two existing lines, take the previous line as your placeholder or use the option to insert at a line number. Add your placeholder into the new file or string, otherwise it will be replaced entirely.
 
+
 A placeholder is optional. If you do not define a placeholder, the content in the existing file will be simply replaced by the new content.
 
 Please try not to use custom placeholders. Keep in mind that you might want to build the project before changing them. Custom placeholders with a comment-syntax (e.g. "//PLACEHOLDER") will be removed by the console-environment and others might cause errors.
@@ -361,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")

engine/engine.ts

@@ -3,13 +3,14 @@ import { Playbook } from "./playbook";
 import { Runner } from "./runner";
 import { RunCommand } from "./run_command";
 import { RunResult } from "./run_result";
+import { SyntaxErrorLogger } from "./syntax_error_logger";
 
 export class Engine {
 
     private runners: Map<string, Runner> = new Map<string, Runner>();
     private variables: Map<string, any> = new Map<string, any>();
 
-    constructor(private environmentName: string, private environment: Environment, private playbook: Playbook) { }
+    constructor(private environmentName: string, private environment: Environment, private playbook: Playbook, private syntaxErrorLogger: SyntaxErrorLogger) { }
 
     async run() {
         for (let runnerIndex in this.environment.runners) {
@@ -69,6 +70,7 @@ export class Engine {
     }
 
     private async isEnvironmentComplete(): Promise<boolean> {
+        let missingFunctions = [];
         for (let stepIndex in this.playbook.steps) {
             for (let lineIndex in this.playbook.steps[stepIndex].lines) {
                 let isSupported = false;
@@ -79,12 +81,16 @@ export class Engine {
                     }
                 }
                 if (!isSupported) {
-                    return false;
+                    missingFunctions.push(this.playbook.steps[stepIndex].lines[lineIndex].name);
                 }
             }
         }
-
-        return true;
+        if(missingFunctions.length > 0) {
+            this.syntaxErrorLogger.handle("Environment incomplete: " + this.environmentName + " | Missing functions: \n - " + missingFunctions.join("\n - "));
+            return false;
+        } else {
+            return true;
+        }
     }
 
     private async getRunner(name: string): Promise<Runner> {

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,7 @@ import { Parser } from "./parser";
 import { Playbook } from "./playbook";
 import { Environment } from "./environment";
 import { Engine } from "./engine";
-import { isObject } from "util";
+import { SyntaxErrorLogger } from "./syntax_error_logger";
 const fs = require('fs');
 const yargs = require('yargs/yargs');
 
@@ -11,22 +11,27 @@ class Run {
     private environments: Map<string, Environment> = new Map<string, Environment>();
     private args: Map<string, string> = new Map<string, string>();
     private errors = [];
+    private syntaxErrorLogger = new SyntaxErrorLogger();
 
     async run(): Promise<boolean> {
         try {
             this.parseArgs();
             if(!this.args.has("debug")) {
                 console.debug = function(){}
             }
+            if(this.args.has("checkSyntax")) {
+                this.syntaxErrorLogger.activate();
+            }
             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];
                 let playbookIndecies = this.filterPlaybooks(this.playbooks)
                 for (let playbookIndex of playbookIndecies) {
-                    let engine = new Engine(key, value, this.playbooks[playbookIndex]);
+                    let engine = new Engine(key, value, this.playbooks[playbookIndex], this.syntaxErrorLogger);
 
                     for (let varEntry of Array.from(this.args.entries())) {
                         engine.setVariable(varEntry[0], varEntry[1]);
@@ -46,7 +51,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;
     }
@@ -67,6 +72,7 @@ class Run {
                 }
             } catch(e) {
                 console.error("Error while parsing playbook: " + playbookDirs[index], e);
+                this.syntaxErrorLogger.handle("Error while parsing playbook: " + playbookDirs[index] + "\n"+ "- " + e);
                 this.errors.push(e);
             }
         }

engine/runner.ts

@@ -11,8 +11,8 @@ export abstract class Runner {
     public playbookPath: string;
     public playbookTitle: string;
     public environmentName: string;
-    protected readonly useDevonCommand: string = "useDevonCommand";
-    protected readonly workspaceDirectory: string = "workspaceDirectory";
+    protected readonly USE_DEVON_COMMAND: string = "useDevonCommand";
+    protected readonly WORKSPACE_DIRECTORY: string = "workspaceDirectory";
 
     private setVariableCallback: (name: string, value: any) => any;
     registerSetVariableCallback(callback: (name: string, value: any) => any) {
@@ -83,7 +83,7 @@ export abstract class Runner {
     }
 
     init(playbook: Playbook): void {
-        this.setVariable(this.useDevonCommand, false);
+        this.setVariable(this.USE_DEVON_COMMAND, false);
     }
 
     run(runCommand: RunCommand): RunResult {