Merge pull request devonfw-tutorials#148 from GuentherJulian/feature/wikiRunner

Feature/wiki runner

Author: SchettlerKoehler

engine/engine.ts

@@ -4,7 +4,6 @@ import { Runner } from "./runner";
 import { RunCommand } from "./run_command";
 import { RunResult } from "./run_result";
 
-
 export class Engine {
 
     private runners: Map<string, Runner> = new Map<string, Runner>();
@@ -106,6 +105,7 @@ export class Engine {
         runner.playbookName = this.playbook.name;
         runner.playbookPath = this.playbook.path;
         runner.playbookTitle = this.playbook.title;
+        runner.environmentName = this.environmentName;
         this.runners.set(name, runner);
     }
 

engine/runner.ts

@@ -10,6 +10,7 @@ export abstract class Runner {
     public playbookName: string;
     public playbookPath: string;
     public playbookTitle: string;
+    public environmentName: string;
     protected readonly useDevonCommand: string = "useDevonCommand";
     protected readonly workspaceDirectory: string = "workspaceDirectory";
 

engine/wikiRunner.ts

@@ -0,0 +1,27 @@
+import { Runner } from "./runner";
+import { Playbook } from "./playbook";
+import * as fs from "fs";
+import * as path from "path";
+import * as ejs from "ejs";
+
+export abstract class WikiRunner extends Runner {
+
+    public outputPathTutorial: string;
+
+    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);
+    }
+
+    destroy(playbook: Playbook): void {
+
+    }
+
+    public renderWiki(templateFile: string, variables: any) {
+        let template = fs.readFileSync(templateFile, 'utf8');
+        let result = ejs.render(template, variables);
+        let tempFile = path.join(this.outputPathTutorial, "wiki.asciidoc");
+        fs.writeFileSync(tempFile, result, { flag: "a" });
+    }
+
+}

environments/wiki_eclipse.json

@@ -0,0 +1,8 @@
+{
+    "failOnIncomplete": false,
+    "runners": [
+        "wikiEclipse",
+        "wikiEditor",
+        "wikiConsole"
+    ]
+}

environments/wiki_vscode.json

@@ -0,0 +1,8 @@
+{
+    "failOnIncomplete": false,
+    "runners": [
+        "wikiVsCode",
+        "wikiEditor",
+        "wikiConsole"
+    ]
+}

runners/wikiConsole/index.ts

@@ -0,0 +1,22 @@
+import { Playbook } from "../../engine/playbook";
+import { RunCommand } from "../../engine/run_command";
+import { RunResult } from "../../engine/run_result";
+import { WikiRunner } from "../../engine/wikiRunner";
+import * as path from "path";
+
+export class WikiConsole extends WikiRunner {
+
+    init(playbook: Playbook): void {
+        super.init(playbook);
+    }
+
+    destroy(playbook: Playbook): void {
+        super.destroy(playbook);
+    }
+
+    runInstallDevonfwIde(runCommand: RunCommand): RunResult {
+        let tools = runCommand.command.parameters[0].join(" ");
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "installDevonfwIde.asciidoc"), { tools: tools })
+        return null;
+    }
+}

runners/wikiConsole/templates/installDevonfwIde.asciidoc

@@ -0,0 +1,30 @@
+defonfw setup
+=============
+
+
+Prerequisites
+~~~~~~~~~~~~~~
+* You need to have a tool to extract `.tar.gz` files. On Windows lower Windows 10 use can use https://www.7-zip.org/7-zip[7-Zip]. The most other platforms support this feature by default.
+* You need to have https://git-scm.com/[Git] and https://curl.se/[Curl] installed. On Windows you have to install https://git-scm.com/download/win[Git for Windows]. On Linux systems you might need to install the following tools in case they are not present (`sudo apt-get install git curl` or `sudo yum install git-core curl`)
+
+Create a new directory in the location where you want to install the devonfw IDE. If you are using the terminal, navigate to this location and run `mkdir devonfw` and `cd devonfw` to create the directory and navigate into it.
+
+Download
+~~~~~~~~~
+Now you have to download the latest release of the devonfw IDE. You can download it from https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.devonfw.tools.ide&a=devonfw-ide-scripts&v=LATEST&p=tar.gz[here].
+
+In the Terminal execute `Invoke-WebRequest -OutFile devonfw-ide-scripts.tar.gz 'https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.devonfw.tools.ide&a=devonfw-ide-scripts&v=LATEST&p=tar.gz'` if you are using Windows.
+
+On Linux use `wget -c 'https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.devonfw.tools.ide&a=devonfw-ide-scripts&v=LATEST&p=tar.gz' -O devonfw-ide-scripts.tar.gz -`.
+
+After that you need to extract the downloaded file. To do this, run `tar -xvzf devonfw-ide-scripts.tar.gz`. Or you can simply use a tool (e.g. 7-Zip) for this.
+
+Setup
+~~~~~~
+First, you need to prepare a settings repository to specify the tools to be installed within the devonfw IDE. Normally this is done by your project. If you just want to test the devonfw IDE, you can use the default URL, which is https://github.com/devonfw/ide-settings.
+
+For now clone the repository on https://github.com/devonfw/ide-settings or your own fork of it.
+For this tutorial you have to write `DEVON_IDE_TOOLS=(<%= tools; %>)` into the devon.properties file of the cloned settings repository. These settings will now be passed into the installation process of the devonfw IDE.
+Start the setup process by executing `.\setup 'path/to/settings'` (Windows) or `bash setup path/to/settings.git` (Linux).
+
+You can also just execute `.\setup` (Windows) or `bash setup` (Linux) and press Enter when the setup assistent asks for the URL to the settings repository. This will also download the default settings and install the default tools within the defonfw IDE.

runners/wikiEclipse/index.ts

@@ -0,0 +1,13 @@
+import { Playbook } from "../../engine/playbook";
+import { WikiRunner } from "../../engine/wikiRunner";
+
+export class WikiEclipse extends WikiRunner {
+
+    init(playbook: Playbook): void {
+        super.init(playbook);
+    }
+
+    destroy(playbook: Playbook): void {
+        super.destroy(playbook);
+    }
+}

runners/wikiEditor/index.ts

@@ -0,0 +1,13 @@
+import { Playbook } from "../../engine/playbook";
+import { WikiRunner } from "../../engine/wikiRunner";
+
+export class WikiEditor extends WikiRunner {
+
+    init(playbook: Playbook): void {
+        super.init(playbook);
+    }
+
+    destroy(playbook: Playbook): void {
+        super.destroy(playbook);
+    }
+}

runners/wikiVsCode/index.ts

@@ -0,0 +1,13 @@
+import { Playbook } from "../../engine/playbook";
+import { WikiRunner } from "../../engine/wikiRunner";
+
+export class WikiVsCode extends WikiRunner {
+
+    init(playbook: Playbook): void {
+        super.init(playbook);
+    }
+
+    destroy(playbook: Playbook): void {
+        super.destroy(playbook);
+    }
+}