#317: added BuildCommandlet

cli/src/main/java/com/devonfw/tools/ide/commandlet/BuildCommandlet.java

@@ -0,0 +1,86 @@
+package com.devonfw.tools.ide.commandlet;
+
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.property.StringProperty;
+import com.devonfw.tools.ide.tool.ToolCommandlet;
+import com.devonfw.tools.ide.tool.gradle.Gradle;
+import com.devonfw.tools.ide.tool.mvn.Mvn;
+import com.devonfw.tools.ide.tool.npm.Npm;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static com.devonfw.tools.ide.variable.IdeVariables.GRADLE_BUILD_OPTS;
+import static com.devonfw.tools.ide.variable.IdeVariables.MVN_BUILD_OPTS;
+import static com.devonfw.tools.ide.variable.IdeVariables.NPM_BUILD_OPTS;
+
+/**
+ * Build tool {@link Commandlet} for automatically detecting build configuration files and running the respective tool.
+ */
+public class BuildCommandlet extends Commandlet {
+
+  /**
+   * The arguments to build with.
+   */
+  public StringProperty arguments;
+
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   */
+  public BuildCommandlet(IdeContext context) {
+
+    super(context);
+    addKeyword(getName());
+    this.arguments = add(new StringProperty("", false, true, "args"));
+  }
+
+  @Override
+  public String getName() {
+
+    return "build";
+  }
+
+  @Override
+  public void run() {
+
+    Path buildPath = this.context.getCwd();
+    String[] defaultToolOptions = new String[0];
+
+    if (buildPath != null) {
+      ToolCommandlet commandlet = null;
+      if (Files.exists(buildPath.resolve("pom.xml"))) {
+        commandlet = this.context.getCommandletManager().getCommandlet(Mvn.class);
+        defaultToolOptions = getDefaultToolOptions(MVN_BUILD_OPTS.getName());
+      } else if (Files.exists(buildPath.resolve("build.gradle"))) {
+        commandlet = this.context.getCommandletManager().getCommandlet(Gradle.class);
+        defaultToolOptions = getDefaultToolOptions(GRADLE_BUILD_OPTS.getName());
+      } else if (Files.exists(buildPath.resolve("package.json"))) {
+        if (Files.exists(buildPath.resolve("yarn.lock"))) {
+          // TODO: add yarn here
+        } else {
+          commandlet = this.context.getCommandletManager().getCommandlet(Npm.class);
+
+          defaultToolOptions = getDefaultToolOptions(NPM_BUILD_OPTS.getName());
+        }
+      }
+
+      if (this.arguments.asArray().length != 0) {
+        defaultToolOptions = this.arguments.asArray();
+      }
+
+      if (commandlet != null) {
+        commandlet.runTool(null, defaultToolOptions);
+      }
+    }
+
+  }
+
+  private String[] getDefaultToolOptions(String buildOptionName) {
+
+    String[] defaultToolOptions;
+    defaultToolOptions = this.context.getVariables().get(buildOptionName).split(" ");
+    return defaultToolOptions;
+  }
+}

cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java

@@ -76,6 +76,7 @@ public CommandletManagerImpl(IdeContext context) {
     add(new UninstallCommandlet(context));
     add(new UpdateCommandlet(context));
     add(new CreateCommandlet(context));
+    add(new BuildCommandlet(context));
     add(new Gh(context));
     add(new Helm(context));
     add(new Java(context));

cli/src/main/java/com/devonfw/tools/ide/variable/IdeVariables.java

@@ -49,6 +49,18 @@ public interface IdeVariables {
 
   /** {@link VariableDefinition} for {@link com.devonfw.tools.ide.context.IdeContext#getWorkspaceName() WORKSPACE}. */
 
+  /** {@link VariableDefinition} for default build options of mvn */
+  VariableDefinitionString MVN_BUILD_OPTS = new VariableDefinitionString("MVN_BUILD_OPTS", null, c -> "");
+
+  /** {@link VariableDefinition} for default build options of npm */
+  VariableDefinitionString NPM_BUILD_OPTS = new VariableDefinitionString("NPM_BUILD_OPTS", null, c -> "");
+
+  /** {@link VariableDefinition} for default build options of gradle */
+  VariableDefinitionString GRADLE_BUILD_OPTS = new VariableDefinitionString("GRADLE_BUILD_OPTS", null, c -> "");
+
+  /** {@link VariableDefinition} for default build options of yarn */
+  VariableDefinitionString YARN_BUILD_OPTS = new VariableDefinitionString("YARN_BUILD_OPTS", null, c -> "");
+
   /** {@link VariableDefinition} for options of jasypt */
   VariableDefinitionString JASYPT_OPTS = new VariableDefinitionString("JASYPT_OPTS", null,
       c -> "algorithm=PBEWITHHMACSHA512ANDAES_256 ivGeneratorClassName=org.jasypt.iv.RandomIvGenerator");
@@ -58,7 +70,7 @@ public interface IdeVariables {
 
   /** A {@link Collection} with all pre-defined {@link VariableDefinition}s. */
   Collection<VariableDefinition<?>> VARIABLES = List.of(PATH, HOME, WORKSPACE_PATH, IDE_HOME, IDE_ROOT, WORKSPACE, IDE_TOOLS, CREATE_START_SCRIPTS,
-      IDE_MIN_VERSION, MVN_VERSION, DOCKER_EDITION, JASYPT_OPTS, MAVEN_ARGS, PROJECT_NAME);
+      IDE_MIN_VERSION, MVN_VERSION, DOCKER_EDITION, MVN_BUILD_OPTS, NPM_BUILD_OPTS, GRADLE_BUILD_OPTS, YARN_BUILD_OPTS, JASYPT_OPTS, MAVEN_ARGS, PROJECT_NAME);
 
   /**
    * @param name the name of the requested {@link VariableDefinition}.

cli/src/main/resources/nls/Help.properties

@@ -1,6 +1,8 @@
 cmd.--version=Print the version of IDEasy.
 cmd.aws=Tool commandlet for AWS CLI.
 cmd.az=Tool commandlet for Azure CLI.
+cmd.build=Runs a build job with given arguments.
+cmd.build.val.args=Build arguments to be used when running a build job.
 cmd.cobigen=Tool commandlet for Cobigen (code-generator).
 cmd.complete=Internal commandlet for bash auto-completion.
 cmd.create=Create a new IDEasy project.

cli/src/main/resources/nls/Help_de.properties

@@ -1,6 +1,8 @@
 cmd.--version=Gibt die Version von IDEasy aus.
 cmd.aws=Werkzeug Kommando für AWS Kommandoschnittstelle.
 cmd.az=Werkzeug Kommando für Azure Kommandoschnittstelle.
+cmd.build=Startet einen build Prozess mit übergebenen Argumenten.
+cmd.build.val.args=Argumente die bei dem build Prozess genutzt werden sollen.
 cmd.cobigen=Werkzeug Kommando für Cobigen.
 cmd.complete=Internes Werkzeug für bash Autovervollständigung.
 cmd.create=Erstellt ein neues IDEasy Projekt.

cli/src/test/java/com/devonfw/tools/ide/commandlet/BuildCommandletTest.java

@@ -0,0 +1,84 @@
+package com.devonfw.tools.ide.commandlet;
+
+import com.devonfw.tools.ide.context.AbstractIdeContextTest;
+import com.devonfw.tools.ide.context.IdeTestContext;
+import com.devonfw.tools.ide.log.IdeLogLevel;
+import com.devonfw.tools.ide.os.SystemInfo;
+import com.devonfw.tools.ide.os.SystemInfoMock;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test of {@link BuildCommandlet}.
+ */
+public class BuildCommandletTest extends AbstractIdeContextTest {
+
+  private static final String PROJECT_BUILD = "build";
+
+  /**
+   * Tests a {@link com.devonfw.tools.ide.tool.mvn.Mvn} build without arguments and expects defaults to be taken from ide.properties.
+   */
+  @Test
+  public void testMvnBuildWithoutProvidedArgumentsUsesDefaultOptions() {
+
+    IdeTestContext context = newContext(PROJECT_BUILD);
+    BuildCommandlet buildCommandlet = context.getCommandletManager().getCommandlet(BuildCommandlet.class);
+    context.setCwd(context.getWorkspacePath().resolve("mvn"), context.getWorkspacePath().toString(), context.getIdeHome());
+    buildCommandlet.run();
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed java in version 17.0.10_7");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed mvn in version 3.9.6");
+    assertLogMessage(context, IdeLogLevel.INFO, "mvn clean install");
+  }
+
+  /**
+   * Tests a {@link com.devonfw.tools.ide.tool.mvn.Mvn} build with provided arguments.
+   */
+  @Test
+  public void testMvnBuildWithProvidedArguments() {
+
+    IdeTestContext context = newContext(PROJECT_BUILD);
+    BuildCommandlet buildCommandlet = context.getCommandletManager().getCommandlet(BuildCommandlet.class);
+    context.setCwd(context.getWorkspacePath().resolve("mvn"), context.getWorkspacePath().toString(), context.getIdeHome());
+    buildCommandlet.arguments.addValue("clean");
+    buildCommandlet.arguments.addValue("install");
+    buildCommandlet.run();
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed java in version 17.0.10_7");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed mvn in version 3.9.6");
+    assertLogMessage(context, IdeLogLevel.INFO, "mvn clean install");
+  }
+
+  /**
+   * Tests a {@link com.devonfw.tools.ide.tool.gradle.Gradle} build with provided arguments.
+   */
+  @Test
+  public void testGradleBuildWithProvidedArguments() {
+
+    IdeTestContext context = newContext(PROJECT_BUILD);
+    BuildCommandlet buildCommandlet = context.getCommandletManager().getCommandlet(BuildCommandlet.class);
+    context.setCwd(context.getWorkspacePath().resolve("gradle"), context.getWorkspacePath().toString(), context.getIdeHome());
+    buildCommandlet.arguments.addValue("task1");
+    buildCommandlet.arguments.addValue("task2");
+    buildCommandlet.run();
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed java in version 17.0.10_7");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed gradle in version 8.7");
+    assertLogMessage(context, IdeLogLevel.INFO, "gradle task1 task2");
+  }
+
+  /**
+   * Tests a {@link com.devonfw.tools.ide.tool.npm.Npm} build with provided arguments.
+   */
+  @Test
+  public void testNpmBuildWithProvidedArguments() {
+
+    SystemInfo systemInfo = SystemInfoMock.of("linux");
+    IdeTestContext context = newContext(PROJECT_BUILD);
+    context.setSystemInfo(systemInfo);
+    BuildCommandlet buildCommandlet = context.getCommandletManager().getCommandlet(BuildCommandlet.class);
+    context.setCwd(context.getWorkspacePath().resolve("npm"), context.getWorkspacePath().toString(), context.getIdeHome());
+    buildCommandlet.arguments.addValue("start");
+    buildCommandlet.arguments.addValue("test");
+    buildCommandlet.run();
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed node in version v18.19.1");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed npm in version 9.9.2");
+    assertLogMessage(context, IdeLogLevel.INFO, "npm start test");
+  }
+}

cli/src/test/resources/ide-projects/build/project/settings/ide.properties

@@ -0,0 +1,6 @@
+JAVA_VERSION=17.0.10_7
+MAVEN_VERSION=3.9.6
+NODE_VERSION=v18.19.1
+NPM_VERSION=9.9.2
+GRADLE_VERSION=8.7
+MVN_BUILD_OPTS=clean install

cli/src/test/resources/ide-projects/build/repository/gradle/gradle/default/bin/gradle

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "gradle $*"

cli/src/test/resources/ide-projects/build/repository/mvn/mvn/default/bin/mvn

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "mvn $*"

cli/src/test/resources/ide-projects/build/repository/npm/npm/default/bin/npm

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "npm $*"

documentation/build.adoc

@@ -0,0 +1,12 @@
+:toc:
+toc::[]
+
+= build
+The `build` commandlet is an abstraction of build systems like link:mvn.asciidoc[maven], link:gradle.asciidoc[gradle], link:npm.asciidoc[yarn], link:npm.asciidoc[npm], etc.
+It will auto-detect your build-system (via existence of files like `pom.xml`, `package.json`, etc.). According to this detection, it will simply delegate to the according commandlet of the specific build system. If that build-system is not yet available it will be downloaded and installed automatically.
+
+So `ide build` allows users to build any project without bothering about the build-system. Further specific build options can be configured per project. This makes `ide build` a universal part of every _definition of done_. Before pushing your changes, please always run the following command to verify the build:
+
+`ide build`
+
+You may also supply additional arguments as `ide build «args»`. This will simply delegate these arguments to the detected build command (e.g. call `mvn «args»`).

documentation/gradle.adoc

@@ -0,0 +1,26 @@
+:toc:
+toc::[]
+
+= gradle
+
+The `gradle` commandlet allows to install, configure, and launch https://gradle.org/[gradle]. It is similar to https://docs.gradle.org/5.3.1/userguide/gradle_wrapper.html[gradle-wrapper]. So calling `ide gradle «args»` is more or less the same as calling `gradle «args»` but with the benefit that the version of gradle preferred by your project is used (and will be installed if not yet available).
+
+The arguments (`ide gradle «args»`) are explained by the following table:
+
+.Usage of `ide gradle`
+[options="header"]
+|=======================
+|*Argument(s)*   |*Meaning*
+|`«args»`        |run gradle with the given arguments (`«args»`)
+|=======================
+
+There are link:variables.asciidoc[variables] that can be used for gradle.
+These are explained by the following table:
+
+.Variables of IDEasy for gradle
+[options="header"]
+|=======================
+|*Variable*|*Meaning*
+|*`GRADLE_VERSION`*       |The version of the tool gradle to install and use.
+|*`GRADLE_BUILD_OPTS`*    |The default arguments to use for the gradle build process e.g. `project1`.
+|=======================

documentation/mvn.adoc

@@ -0,0 +1,27 @@
+:toc:
+toc::[]
+
+= mvn
+
+The `mvn` commandlet allows to install, configure, and launch https://maven.apache.org/[maven]. It is similar to https://github.com/takari/maven-wrapper[maven-wrapper] and https://github.com/dansomething/mdub[mdub]. So calling `ide mvn «args»` is more or less the same as calling `mvn «args»` but with the benefit that the version of maven preferred by your project is used (and will be installed if not yet available).
+
+The arguments (`ide mvn «args»`) are explained by the following table:
+
+.Usage of `ide mvn`
+[options="header"]
+|=======================
+|*Argument(s)*             |*Meaning*
+|                          |run default build, link:configuration.asciidoc[configurable] via `MVN_BUILD_OPTS`
+|`«args»`                  |run maven with the given arguments (`«args»`)
+|=======================
+
+There are link:variables.asciidoc[variables] that can be used for mvn.
+These are explained by the following table:
+
+.Variables of IDEasy for mvn
+[options="header"]
+|=======================
+|*Variable*|*Meaning*
+|*`MVN_VERSION`*          |The version of the tool mvn to install and use.
+|*`MVN_BUILD_OPTS`*       |The default options to use for the mvn build process e.g. `clean install`.
+|=======================

documentation/npm.adoc

@@ -0,0 +1,27 @@
+:toc:
+toc::[]
+
+= npm
+
+The `npm` commandlet allows to install, configure, and launch https://www.npmjs.com/[npm]. Calling `ide npm «args»` is more or less the same as calling `npm «args»` but with the benefit that the version of npm preferred by your project is used (and will be installed if not yet available).
+
+The arguments (`ide npm «args»`) are explained by the following table:
+
+.Usage of `ide npm`
+[options="header"]
+|=======================
+|*Argument(s)*             |*Meaning*
+|                          |run default build, link:configuration.asciidoc[configurable] via `NPM_BUILD_OPTS`
+|`«args»`                  |run NPM with the given arguments (`«args»`)
+|=======================
+
+There are link:variables.asciidoc[variables] that can be used for npm.
+These are explained by the following table:
+
+.Variables of IDEasy for npm
+[options="header"]
+|=======================
+|*Variable*|*Meaning*
+|*`NPM_VERSION`*          |The version of the tool npm to install and use.
+|*`NPM_BUILD_OPTS`*       |The default options to use for the npm build process e.g. `run start`.
+|=======================

documentation/yarn.adoc

@@ -0,0 +1,26 @@
+:toc:
+toc::[]
+
+= yarn
+
+The `yarn` commandlet allows to install, configure, and launch https://www.npmjs.com/[npm]. Calling `ide yarn «args»` is more or less the same as calling `yarn «args»` but with the benefit that the version of npm preferred by your project is used (and will be installed if not yet available).
+
+The arguments (`ide yarn «args»`) are explained by the following table:
+
+.Usage of `ide yarn`
+[options="header"]
+|=======================
+|*Argument(s)*             |*Meaning*
+|`«args»`                  |run yarn with the given arguments (`«args»`)
+|=======================
+
+There are link:variables.asciidoc[variables] that can be used for yarn.
+These are explained by the following table:
+
+.Variables of IDEasy for yarn
+[options="header"]
+|=======================
+|*Variable*|*Meaning*
+|*`YARN_VERSION`*          |The version of the tool yarn to install and use.
+|*`YARN_BUILD_OPTS`*       |The default options to use for the yarn build process e.g. `run start`.
+|=======================