Skip to content

Functions

Jump to bottom
GuentherJulian edited this page Apr 9, 2021 · 39 revisions

Functions

The following functions are already implemented:

  • installDevonfwIde
  • restoreDevonfwIde
  • restoreWorkspace
  • changeWorkspace
  • installCobiGen
  • cobiGenJava
  • createDevon4jProject
  • buildJava
  • createFile
  • changeFile
  • createFolder
  • cloneRepository
  • runServerJava
  • buildNg
  • npmInstall
  • dockerCompose
  • downloadFile
  • nextKatacodaStep
  • adaptTemplatesCobiGen
  • createDevon4ngProject

installDevonfwIde

parameter

  1. The tools you want to install within the devonfw ide: string array
  2. Optional: The version of the ide to install

example

installDevonfwIde(["java","mvn"], "2020.08.001")

restoreDevonfwIde

parameter

  1. The tools you want to install within the devonfw ide: string array
  2. Optional: The version of the ide to install

example

restoreDevonfwIde(["java","mvn"], "2020.08.001")

details

In the Katacoda environment the installation of the devonfw IDE is executed in a startup script.

restoreWorkspace

parameter

  1. (Optional):
    • Name of the workspace repository {"workspace": string} (Default is the playbook-name)
    • local workspace {"local": boolean} (Default is false)

arguments

User(Optional) flag: --user value: GitHub-username (Default is 'devonfw-tutorials')

You can use a forked workspace-repository, if you add the username as argument. If the runner cannot find the workspace repository in the your repositories, it will use devonfw-tutorials instead.

Branch(Optional) flag: --branch value: the working branch (Default is its default-branch)

You can use a different branch, if you add the working branch as argument. If the runner cannot find the branch in the cloned repository, it will use the default branch instead.

buildRun.sh --user [username] --branch [branch]

example

restoreWorkspace() will clone "https://github.com/devonfw-tutorials/[playbook-name]" into the workspace directory.

restoreWorkspace({"workspace": [name]}) will clone "https://github.com/devonfw-tutorials/[name]" into the workspace directory.

buildRun.sh --user [GitHub-name] --branch [branch] restoreWorkspace() will run "git clone https://github.com/[GitHub-name]/[playbook-name]" and checkout in branch [branch]

details

workspace The default name of the workspace repository is a concatenation of "workspace-" and the name of your playbook-folder. If you want to use another repository as workspace, you can specify the ending with {"workspace": [name]}. example "workspace-devon4ng" -> {"workspace" : "devon4ng"}

local You can use a local repository as workspace in your tutorial. Clone the forked repository next to the tutorial-compiler folder and set the "local"-parameter to true {"local": true}

|--tutorial-compiler
|--tutorials 
|--workspace-devon4ng

changeWorkspace

parameter

  1. path to a new workspace (relative to working directory)

example

changeWorkspace("devonfw/workspaces/project") will set the workspace directory to "[working directory]/devonfw/workspaces/project"

Learn more about the workspace directory and working direktory on Structure

installCobiGen

parameter

  • No parameters

example

installCobiGen()

cobiGenJava

parameter

  1. The path to the java file you want to generate code for: string
  2. The numbers that represent the templates that CobiGen uses to generate code: int array

example

cobiGenJava("path/to/java/file/MyEntity.java",[1,3,5,6,8])

details

Number Description
1 CRUD logic: Generates the logic layer and implementations for some use cases.
3 CRUD REST services: Generates the service layer with CRUD operations for using in REST services.
5 TO's: Generates the related Transfer Objects.
6 Entity infrastructure: Creates the entity main interface and edits (by a merge) the current entity to extend the newly generated classes.
8 CRUD SpringData Repository: Generates the entity repository (that contains the CRUD operations) in the data access layer.

createDevon4jProject

parameter

  1. The project name

example

createDevon4jProject("cobigenexample")

buildJava

parameter

  1. The project directory
  2. (Optional) Indicator whether tests should be run. Default is false.

example

buildJava("cobigenexample", true)

createFile

parameter

  1. Path of the file to be created (relative path to the workspace directory)
  2. (Optional) Path of the file to get the content from. Relative to the playbook directory

example

createFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java", "files/CustomerEntity.java")

changeFile

parameter

  1. Path of the file to be changed (relative path to the workspace directory)
  • 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;" })

details

Path of the file to get the content from or a string, that should be inserted.

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.

example:{...,"placeholder": "private int age;"}

Before Content or File After

private int age;

public String getFirstname() {
return firstname;
}

private int age;

private String company;
public String getCompany() {
return firstname;
}
public void setCompany(String company) {
this.company = company;
}

private int age;

private String company;
public String getCompany() {
return firstname;
}
public void setCompany(String company) {
this.company = company;

public String getFirstname() {
return firstname;
}

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.

createFolder

parameter

  1. Path of the folder to be created, relative to the workspace directory. Subdirectories are also created.

example

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

If the tutorial should be tested on the console environment, you have to specify a port.

npmInstall

parameter

  1. Path to the project where the dependencies from the package.json file are to be installed.
  2. Json-object: Name of a package, global or local installation, or array of npm arguments
  • (Optional) name of a package {"name": string }
  • (Optional) global or local installation. Default is local, therefore false {"global" : boolean }
  • (Optional) array of npm arguments {"args": string[]}

example

npmInstall("jump-the-queue/angular", {"name": "@angular/cli", "global": true, "args": ["--save-dev"]}) will run 'npm install -g --save-dev @angular/cli' in the directory 'jump-the-queue/angular'.

npmInstall("my-thai-star/angular") will run 'npm install' in the directory 'my-thai-star/angular'

dockerCompose

parameter

  1. Path to the directory where the docker-compose.yml file is located, relative to workspace.
  2. Assertion information. Only needed for the console runner to check if the server was started properly.

example

dockerCompose("my-thai-star", { "startupTime": 600, "port": 8081, "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

If the tutorial should be tested on the console environment, you have to specify a port.

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

If the tutorial should be tested on the console environment, you have to specify a port.

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.
  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" }])

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.

adaptTemplatesCobiGen

parameter

  • No parameters

example

adaptTemplatesCobiGen()

createDevon4ngProject

parameter

  1. Name of the Project.
  2. Path to where the Project should be created (relative to workspace). Folder should exist.
  3. (Optional) String array of parameters, according to https://angular.io/cli/new.

example

createDevon4ngProject("exampleAngularProject", "") Will create the angular project to the current workspace with the name exampleAngularProject.

createDevon4ngProject("exampleAngularProject", "projects", ["--verbose"]) Will create the angular project to the directory projects within the current workspace and adds more details to output logging.

Details

This command also works if the devonfw IDE is not installed, but then you have to make sure that the Angular cli is installed.

Clone this wiki locally