Merge remote-tracking branch 'UPSTREAM/main' into feature/katacodaDockerCompose

# Conflicts:
#	documentation/Functions.md

Author: MarcelDiessner

assertions/index.ts

@@ -7,6 +7,8 @@ import { DirectoryExist } from "./directoryExist";
 import { FileExist } from "./fileExist";
 import { DirectoryNotEmpty } from "./directoryNotEmpty";
 import { FileContains } from "./fileContains";
+import { ServerIsReachable } from "./serverIsReachable";
+import { RepositoryIsClean } from "./repositoryIsClean";
 
 
 export class Assertions {
@@ -40,4 +42,13 @@ export class Assertions {
         FileContains.run(filepath, content);
         return this;
     }
+
+    public serverIsReachable(port: number, path: string): Promise<boolean> {
+        return ServerIsReachable.run(port, path);
+    }
+
+    public repositoryIsClean(directory: string): Assertions {
+        RepositoryIsClean.run(directory);
+        return this;
+    }
 }

assertions/repositoryIsClean.ts

@@ -0,0 +1,12 @@
+import * as child_process from "child_process";
+
+export class RepositoryIsClean {
+    public static run(directory: string): void {
+        let process = child_process.spawnSync("git status -s", { shell: true, cwd: directory });
+        if(process.status != 0) {
+            throw new Error("'git status -s' execution in directory " + directory + " returned error.")
+        } else if(process.stdout.toString()) {
+            throw new Error("Repository in directory " + directory + " is not clean. Current Status: " + process.stdout.toString());
+        }
+    }
+}

assertions/serverIsReachable.ts

@@ -0,0 +1,7 @@
+import * as isReachable from "is-reachable";
+
+export class ServerIsReachable {
+    public static run(port: number, path: string): Promise<boolean> {
+        return isReachable("http://localhost:" + port + "/" + path);
+    }
+}

documentation/Functions.md

@@ -1,12 +1,20 @@
 ## Functions 
 The following functions are already implemented:
-* installDevonIde
+* installDevonfwIde
+* restoreDevonfwIde
 * installCobiGen
 * cobiGenJava
 * createDevon4jProject
 * buildJava
 * createFile
-* dockerCompose
+* changeFile
+* createFolder
+* cloneRepository
+* runServerJava
+* buildNg
+* npmInstall
+* downloadFile
+* nextKatacodaStep
 
 ***
 
@@ -84,7 +92,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.
  * (Optional) Name of a placeholder 
 #### example 
 changeFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java", { "file": "files/Placeholder.java", "placeholder": "private static final long serialVersionUID = 1L;" })
@@ -94,6 +102,8 @@ If you want to add content from a file:
 {"file": "[path]"}
 If you want to add a string to a file: 
 {"content": "[string]"}
+If you want to add different contents for the katacoda and console runner, then use the properties "fileConsole" and "fileKatacoda" or "contentConsole" and "contentKatacoda":
+{"fileConsole": "[pathToConsoleFile]", "fileKatacoda": "[pathToKatacodaFile]"}
 ##### Name of the placeholder
 If you want to insert content into your code between two existing lines, take the previous line as your placeholder. Add your placeholder into the new file or string, otherwise it will be replaced entirely.
 
@@ -108,11 +118,100 @@ Please try not to use custom placeholders. Keep in mind that you might want to b
 
 ***
 
-### dockerCompose
+### createFolder
 #### parameter 
-1. Path to the Dockerfile
+1. Path of the folder to be created, relative to the workspace directory. Subdirectories are also created.
 #### example 
-dockerCompose("exampleproject")
+createFolder("directoryPath/subDirectory")
+
+***
+
+### cloneRepository
+#### parameter 
+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")
+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.
+
+***
+
+
+### runServerJava
+#### parameter 
+1. Path to the server directory within the java project.
+2. Assertion information. Only needed for the console runner to check if the server was started properly.
+#### example 
+runServerJava("devonfw/workspaces/main/jump-the-queue/java/jtqj/server", { "startupTime": 40, "port": 8081, "path": "jumpthequeue" })
+
+##### 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
+
+***
+
+### npmInstall
+#### parameter 
+1. Path to the project where the dependencies from the package.json file are to be installed.
+#### example 
+npmInstall("my-thai-star/angular")
+
+***
+
+### downloadFile
+#### parameter 
+1. URL of the file to be downloaded.
+2. Name of file.
+3. (Optional) Downloads file to a given directory relative to workspace. Directory is created, if its not existing.
+#### example 
+downloadFile("https://bit.ly/2BCkFa9", "file", "downloads")
+
+***
+
+### buildNg
+#### parameter 
+1. Path to the angular project relative to workspace
+2. (Optional) Custom output directory.
+#### example 
+buildNg("exampleAngularProject")
+Will build the angular project to default output directory defined in angular.json outputPath key, normally set to dist/.
+
+buildNg("exampleAngularProject", "testOutput")
+Will build the angular project to output directory testOutput.
+
+***
+
+### runClientNg
+#### parameter 
+1. Path to the angular project from which the frontend server is to be started.
+2. Assertion information. Only needed for the console runner to check if the server was started properly.
+#### example 
+runClientNg("jump-the-queue/angular", { "startupTime": 200, "port": 4200, "path": "" })
+
+##### 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
+
+***
+
+### nextKatacodaStep
+#### 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.
+#### example 
+nextKatacodaStep("Step title", [{ "file": "files/description.md" }, { "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.
 
 ***
 

engine/runner.ts

@@ -5,14 +5,14 @@ import { Step } from "./step";
 import * as fs from 'fs';
 import * as rimraf from 'rimraf';
 
-const nameof = <T>(name: Extract<keyof T, string>): string => name;
-
 export abstract class Runner {
     public path: string;
     public name: string;
     public playbookName: string;
     public playbookPath: string;
     public playbookTitle: string;
+    protected readonly useDevonCommand: string = "useDevonCommand";
+    protected readonly workspaceDirectory: string = "workspaceDirectory";
 
     private setVariableCallback: (name: string, value: any) => any;
     registerSetVariableCallback(callback: (name: string, value: any) => any) {
@@ -83,6 +83,7 @@ export abstract class Runner {
     }
 
     init(playbook: Playbook): void {
+        this.setVariable(this.useDevonCommand, false);
     }
 
     run(step: Step, command: Command): RunResult {