Feature/wikirunnerCreateDevon4jProject (devonfw-tutorials#237)

added createDevon4jProject operation for wikirunner

Author: MarcelDiessner

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

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];

localBuildRun.ps1

@@ -5,4 +5,4 @@ Copy-Item -Force -Recurse -Path $PSScriptRoot\environments\ -Destination $PSScri
 Copy-Item -Force -Recurse -Path $PSScriptRoot\runners\ -Destination $PSScriptRoot\build
 npm test
 if(-not $?) { throw 'tests failed' } 
-node $PSScriptRoot\build\engine\run.js $args
+node $PSScriptRoot\build\engine\run.js $args 

runners/console/consoleUtils.ts

@@ -27,6 +27,7 @@ export class ConsoleUtils {
         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/wikiConsole/index.ts

@@ -116,5 +116,10 @@ export class WikiConsole extends WikiRunner {
         this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "buildJava.asciidoc"), { directoryPath: directoryPath, skipTest: skipTest });
         return null;
     }
+
+    runCreateDevon4jProject(runCommand: RunCommand): RunResult {
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "createDevon4jProject.asciidoc"), { name: runCommand.command.parameters[0] });
+        return null;
+    }
 }
 

runners/wikiConsole/templates/createDevon4jProject.asciidoc

@@ -0,0 +1,44 @@
+== Create a new devon4j project
+
+=== Create a new devon4j project from command prompt
+
+==== Prerequisites
+
+In order to create a new application you must use the archetype provided by devon4j which uses the https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[maven archetype functionality].
+
+To create a new application, you should have installed devonfw-ide. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
+
+==== Create the project
+
+Now you can use devonfw to setup a java project for you by executing the following devon command in terminal.
+
+`devon java create <%= name; %>`
+
+There is also is also an alternative way, where you can customize the project setup with optional parameters. More informations you will find https://devonfw.com/website/pages/docs/devon4j.asciidoc_tutorials.html[here].
+
+==== What is generated?
+
+The application template (archetype) generates a Maven multi-module project. It has the following modules:
+
+- *api*: module with the API (REST service interfaces, transfer-objects, datatypes, etc.) to be imported by other apps as a maven dependency in order to invoke and consume the offered (micro)services.
+
+- *core*: maven module containing the core of the application.
+
+- *batch*: optional module for batch(es)
+
+- *server*: module that bundles the entire app (core with optional batch) as a WAR file.
+
+- *ear*: optional maven module is responsible to packaging the application as a EAR file.
+
+The toplevel pom.xml of the generated project has the following features:
+
+- Properties definition: Spring-boot version, Java version, etc.
+
+- Modules definition for the modules (described above)
+
+- Dependency management: define versions for dependencies of the technology stack that are recommended and work together in a compatible way.
+
+- Maven plugins with desired versions and configuration
+
+- Profiles for https://devonfw.com/website/pages/docs/devon4j.asciidoc_guides.html#guide-testing.asciidoc[test stages]
+

runners/wikiEclipse/index.ts

@@ -40,4 +40,9 @@ export class WikiEclipse extends WikiRunner {
             contentFile: contentFile, fileName: fileName});
         return null;
     }
+
+    runCreateDevon4jProject(runCommand: RunCommand): RunResult {
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "createDevon4jProject.asciidoc"), { name: runCommand.command.parameters[0]});
+        return null;
+    }
 }

runners/wikiEclipse/templates/createDevon4jProject.asciidoc

@@ -0,0 +1,42 @@
+== Create a new devon4j project
+
+=== Create a new devon4j project in the Eclipse IDE
+
+==== Prerequisites
+
+In order to create a new application you must use the archetype provided by devon4j which uses the https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[maven archetype functionality].
+
+To create a new application, you should have installed devonfw-ide. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
+
+==== Create the project
+
+Firstly, create a new maven project.
+Then, choose the 'devon4j-template-server' archetype.
+Fill the _Group Id_, _Artifact Id_, _version_ and _package_ for your project. The _package_ name should be <%= name; %>. If you want to add an EAR generation mechanism to your project, you should fill the property _earProjectName_ with the value _Artifact Id_ + "-ear". For example, "sampleapp-ear".
+
+==== What is generated?
+
+The application template (archetype) generates a maven multi-module project. It has the following modules:
+
+- *api*: module with the API (REST service interfaces, transfer-objects, datatypes, etc.) to be imported by other apps as a maven dependency in order to invoke and consume the offered (micro)services.
+
+- *core*: maven module containing the core of the application.
+
+- *batch*: optional module for batch(es)
+
+- *server*: module that bundles the entire app (core with optional batch) as a WAR file.
+
+- *ear*: optional maven module is responsible to packaging the application as a EAR file.
+
+The toplevel pom.xml of the generated project has the following features:
+
+- Properties definition: Spring-boot version, Java version, etc.
+
+- Modules definition for the modules (described above)
+
+- Dependency management: define versions for dependencies of the technology stack that are recommended and work together in a compatible way.
+
+- Maven plugins with desired versions and configuration
+
+- Profiles for https://devonfw.com/website/pages/docs/devon4j.asciidoc_guides.html#guide-testing.asciidoc[test stages]
+