Merge pull request #290 from EduardKrieger/bugfix/wikiRunnerStepDescription

Bugfix/wiki runner step description

Author: EduardKrieger

documentation/Functions.md

@@ -18,7 +18,7 @@ The following functions are already implemented:
 * [npmInstall](#npmInstall)
 * [dockerCompose](#dockerCompose)
 * [downloadFile](#downloadFile)
-* [nextKatacodaStep](#nextKatacodaStep)
+* [displayContent](#displayContent)
 * [adaptTemplatesCobiGen](#adaptTemplatesCobiGen)
 * [createDevon4ngProject](#createDevon4ngProject)
 * [addSetupScript](#addSetupScript)
@@ -349,20 +349,46 @@ path: The URL path on which is checked if the server is running
 If the tutorial should be tested on the console environment, you have to specify a port.
 ***
 
-### nextKatacodaStep <a name="nextKatacodaStep"></a>
+### displayContent <a name="displayContent"></a>
 #### parameter
-1. The title of the step.
-2. An array of json objects with files, content, or images to be rendered within the katacoda step.
+1. The title of the step. 
+2. An array of json objects with files, content, or images to be rendered within the Katacoda step. The use for this function is to display an image and some descriptive text. No Katacoda syntax is allowed in the files or the content!
 3. (Optional) Path to the current directory where the user is located (relative to the workspace directory). Only needed if the directory is changed within this step.
 #### example 
-nextKatacodaStep("Step title", [{ "file": "files/description.md" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
+display("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
 
 #### Details
 Available attributes in the json objects:
 
-file: Path to a file whose content is to be displayed in the katacoda step (e.g. .md or .txt file).
-content: Plain text to be displayed in the katacoda step.
-image: Path to an image to be displayed in the katacoda step.
+1. file: Path to a file whose content is to be displayed in the Katacoda step (e.g. .asciidoc or .txt file). The file should be following the formating of asciidoc files. 
+2. content: Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
+3. image: Path to an image to be displayed in the Katacoda step.
+
+#### Formatting rules for content and .asciidoc or .txt files.
+* You can add headers to structure your text. The generated headers are shown in the examples below. The headers should fit into the overall structure of the generated wiki so level 1 header are not allowed, but the other header can be used at your judgement.
+* A list always needs an empty newline between the last row and the list.
+* Use asciidoc style of links
+
+#### examples
+``` 
+Existing header structure
+= Level 1: tutorial title
+== Level 2: subtitle
+=== Level 3: prerequisites and learning goals
+== Level 2: steptitle
+=== Level 3: titles from functions 
+==== Level 4: subtitles from functions
+== Level 2: conclusion
+
+List:
+This an unordered List (The empty line is necessary)
+
+* First Item
+* Second Item
+
+Link:
+The tutorials repository can be found https://github.com/devonfw-tutorials/tutorials/issues[here].
+```
 
 ***
 

engine/wikiRunner.ts

@@ -1,23 +1,30 @@
 import { Runner } from "./runner";
 import { Playbook } from "./playbook";
+import { RunCommand } from "./run_command";
 import * as fs from "fs";
 import * as path from "path";
 import * as ejs from "ejs";
 
 export abstract class WikiRunner extends Runner {
 
     public outputPathTutorial: string;
+    public commandCntMap = new Map();
+
+    protected readonly INSTALLED_TOOLS: string = "installedTools";
     protected fileTypeMap = new Map([ [".java", "java"],[".ts", "typescript"],
     [".js", "javascript"], [".html", "html"],
     [".scss", "css"], [".asciidoc", "asciidoc"], ]);
-    protected readonly INSTALLED_TOOLS: string = "installedTools";
+    
 
 
     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.WORKSPACE_DIRECTORY, path.join(this.getWorkingDirectory()));
         this.setVariable(this.INSTALLED_TOOLS, "");
+        for(let i = 0; i< playbook.steps.length; i++){
+            this.commandCntMap.set(i, playbook.steps[i].lines.length-1);
+        }
     }
 
     async destroy(playbook: Playbook): Promise<void> {
@@ -31,4 +38,22 @@ export abstract class WikiRunner extends Runner {
         fs.writeFileSync(tempFile, result, { flag: "a" });
     }
 
+    protected checkForText(runCommand: RunCommand): string{    
+        return runCommand.lineIndex == 0 
+            ? runCommand.text
+            : undefined; 
+    }
+
+    protected checkForTitle(runCommand: RunCommand): string{    
+        return runCommand.lineIndex == 0 
+            ? runCommand.stepTitle
+            : undefined; 
+    }
+
+    protected checkForTextAfter(runCommand: RunCommand): string{
+        return this.commandCntMap.get(runCommand.stepIndex) == runCommand.lineIndex 
+            ? runCommand.textAfter
+            : undefined;
+    }
+
 }

runners/console/index.ts

@@ -413,7 +413,7 @@ export class Console extends Runner {
         return result;
     }
 
-    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+    runDisplayContent(runCommand: RunCommand): RunResult {
         //Only needed for katacoda and wiki runner
         return null;
     }
@@ -941,16 +941,6 @@ export class Console extends Runner {
             for(let asyncProcess of this.asyncProcesses) {
                 killProcessesRecursively(systemProcesses, asyncProcess.pid);
             }
-        }
-        for(let proc of systemProcesses){
-            if(path.normalize(proc.path).includes(path.normalize(this.getWorkingDirectory()))){
-                try {
-                    process.kill(proc.pid);
-                } catch(e) {
-                        console.error("Error killing process "+proc.name+" with id: " + proc.pid , e);
-                }
-            }
-        }
             //Check if there are still running processes on the given ports
             // Maybe not needed anymore can be deleted and the function documentation should be updated
             for(let asyncProcess of this.asyncProcesses.reverse()) {
@@ -965,9 +955,17 @@ export class Console extends Runner {
                         }
                     }
                 }      
-            
-
+            for(let proc of systemProcesses){
+                if(path.normalize(proc.path).includes(path.normalize(this.getWorkingDirectory()))){
+                    try {
+                        process.kill(proc.pid);
+                    } catch(e) {
+                        console.error("Error killing process "+proc.name+" with id: " + proc.pid , e);
+                    }
+                }
+            }
         }
+    }
 
     private async cleanUp(): Promise<void> {
         await this.killAsyncProcesses();

runners/katacoda/index.ts

@@ -344,7 +344,7 @@ export class Katacoda extends Runner {
         return null;
     }
 
-    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+    runDisplayContent(runCommand: RunCommand): RunResult {
         let tempFile = path.join(this.getTempDirectory(), runCommand.command.name + ".md");
         fs.writeFileSync(tempFile, "");
         for(let i = 0; i < runCommand.command.parameters[1].length; i++) {
@@ -364,7 +364,7 @@ export class Katacoda extends Runner {
         let content = fs.readFileSync(tempFile, "utf-8");
         this.pushStep(runCommand, runCommand.command.parameters[0], "step" + runCommand.stepIndex + ".md");
 
-        this.renderTemplate("nextKatacodaStep.md", this.outputPathTutorial + "step" + runCommand.stepIndex + ".md", { text: runCommand.text, textAfter: runCommand.textAfter, content: content });
+        this.renderTemplate("displayContent.md", this.outputPathTutorial + "step" + runCommand.stepIndex + ".md", { text: runCommand.text, textAfter: runCommand.textAfter, content: content });
 
         if(runCommand.command.parameters[2]) {
             this.currentDir = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[2]);