#342: implement unit tests for mvn ToolCommandlet

cli/src/main/java/com/devonfw/tools/ide/tool/mvn/Mvn.java

@@ -37,21 +37,22 @@ public class Mvn extends PluginBasedCommandlet {
    */
   public static final String MVN_CONFIG_LEGACY_FOLDER = ".m2";
 
+  /** The name of the settings-security.xml */
+  public static final String SETTINGS_SECURITY_FILE = "settings-security.xml";
+
   /**
    * The name of the settings.xml
    */
   public static final String SETTINGS_FILE = "settings.xml";
 
-  private static final String SETTINGS_SECURITY_FILE = "settings-security.xml";
-
   private static final String DOCUMENTATION_PAGE_CONF = "https://github.com/devonfw/IDEasy/blob/main/documentation/conf.adoc";
 
-  private static final String ERROR_SETTINGS_FILE_MESSAGE =
-          "Failed to create settings file at: {}. For further details see:\n" + DOCUMENTATION_PAGE_CONF;
+  private static final String ERROR_SETTINGS_FILE_MESSAGE = "Failed to create settings file at: {}. For further details see:\n" + DOCUMENTATION_PAGE_CONF;
 
   private static final String ERROR_SETTINGS_SECURITY_FILE_MESSAGE =
-          "Failed to create settings security file at: {}. For further details see:\n" + DOCUMENTATION_PAGE_CONF;
-  public static final VariableSyntax VARIABLE_SYNTAX = VariableSyntax.SQUARE;
+      "Failed to create settings security file at: {}. For further details see:\n" + DOCUMENTATION_PAGE_CONF;
+
+  private static final VariableSyntax VARIABLE_SYNTAX = VariableSyntax.SQUARE;
 
   /**
    * The constructor.
@@ -96,7 +97,8 @@ public void postInstall() {
           templatesConfMvnFolder = templatesConfMvnLegacyFolder;
           legacy = true;
         } else {
-          this.context.warning("No maven templates found. Neither in {} nor in {} - configuration broken", templatesConfMvnFolder, templatesConfMvnLegacyFolder);
+          this.context.warning("No maven templates found. Neither in {} nor in {} - configuration broken", templatesConfMvnFolder,
+              templatesConfMvnLegacyFolder);
           hasMvnTemplates = false;
         }
       }
@@ -133,11 +135,11 @@ private void createSettingsSecurityFile(Path settingsSecurityFile) {
 
       ProcessResult result = pc.run(ProcessMode.DEFAULT_CAPTURE);
 
-      String encryptedMasterPassword = result.getOut().toString();
+      String encryptedMasterPassword = result.getOut().get(0);
 
       String settingsSecurityXml =
-              "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" + "<settingsSecurity>\n" + "  <master>" + encryptedMasterPassword + "</master>\n"
-                      + "</settingsSecurity>";
+          "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" + "<settingsSecurity>\n" + "  <master>" + encryptedMasterPassword + "</master>\n"
+              + "</settingsSecurity>";
       try {
         Files.writeString(settingsSecurityFile, settingsSecurityXml);
         step.success();
@@ -169,7 +171,7 @@ private void createSettingsFile(Path settingsFile, Path settingsSecurityFile, Pa
         } else if (!gitSettingsUrl.equals(gitContext.DEFAULT_SETTINGS_GIT_URL)) {
           Set<String> variables = findVariables(content);
           for (String variable : variables) {
-            String secret = getEncryptedPassword(variable, settingsSecurityFile);
+            String secret = getEncryptedPassword(variable);
             content = content.replace(VARIABLE_SYNTAX.create(variable), secret);
           }
         }
@@ -182,15 +184,15 @@ private void createSettingsFile(Path settingsFile, Path settingsSecurityFile, Pa
     }
   }
 
-  private String getEncryptedPassword(String variable, Path settingsSecurityFile) {
+  private String getEncryptedPassword(String variable) {
 
     String input = this.context.askForInput("Please enter secret value for variable " + variable + ":");
 
     ProcessContext pc = this.context.newProcess().executable("mvn");
     pc.addArgs("--encrypt-password", input);
     ProcessResult result = pc.run(ProcessMode.DEFAULT_CAPTURE);
 
-    String encryptedPassword = result.getOut().toString();
+    String encryptedPassword = result.getOut().get(0);
     this.context.info("Encrypted as " + encryptedPassword);
 
     return encryptedPassword;
@@ -216,7 +218,7 @@ public void installPlugin(PluginDescriptor plugin) {
       this.context.success("Successfully added {} to {}", plugin.getName(), mavenPlugin.toString());
     } else {
       this.context.warning("Plugin {} has wrong properties\n" //
-              + "Please check the plugin properties file in {}", mavenPlugin.getFileName(), mavenPlugin.toAbsolutePath());
+          + "Please check the plugin properties file in {}", mavenPlugin.getFileName(), mavenPlugin.toAbsolutePath());
     }
   }
 }

cli/src/test/java/com/devonfw/tools/ide/context/GitContextMock.java

@@ -6,6 +6,9 @@
  * Mock implementation of {@link GitContext}.
  */
 public class GitContextMock implements GitContext {
+
+  private static final String MOCKED_URL_VALUE = "mocked url value";
+
   @Override
   public void pullOrCloneIfNeeded(String repoUrl, String branch, Path targetRepository) {
 
@@ -49,6 +52,6 @@ public void cleanup(Path targetRepository) {
   @Override
   public String retrieveGitUrl(Path repository) {
 
-    return null;
+    return MOCKED_URL_VALUE;
   }
 }

cli/src/test/java/com/devonfw/tools/ide/context/IdeTestContext.java

@@ -6,12 +6,16 @@
 import com.devonfw.tools.ide.repo.ToolRepository;
 
 import java.nio.file.Path;
+import java.util.LinkedList;
+import java.util.List;
 
 /**
  * Implementation of {@link IdeContext} for testing.
  */
 public class IdeTestContext extends AbstractIdeTestContext {
 
+  private LinkedList<String> inputValues;
+
   /**
    * The constructor.
    *
@@ -62,4 +66,20 @@ public static IdeTestContext of() {
     return new IdeTestContext(Path.of("/"));
   }
 
+  /**
+   * Set a mocked value to be returned by the {@link IdeContext#askForInput(String)} method
+   *
+   * @param values a {@link LinkedList} with the mocked input value
+   */
+  public void setInputValues(List<String> values) {
+
+    this.inputValues = new LinkedList<>(values);
+  }
+
+  @Override
+  public String askForInput(String message) {
+
+    return inputValues.isEmpty() ? null : inputValues.poll();
+  }
+
 }

cli/src/test/java/com/devonfw/tools/ide/tool/mvn/MvnTest.java

@@ -0,0 +1,96 @@
+package com.devonfw.tools.ide.tool.mvn;
+
+import com.devonfw.tools.ide.commandlet.InstallCommandlet;
+import com.devonfw.tools.ide.context.AbstractIdeContextTest;
+import com.devonfw.tools.ide.context.IdeTestContext;
+import com.devonfw.tools.ide.log.IdeLogLevel;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+/**
+ * Integration test of {@link Mvn}.
+ */
+public class MvnTest extends AbstractIdeContextTest {
+
+  private static final String PROJECT_MVN = "mvn";
+
+  //private static final Pattern VARIABLE_PATTERN = Pattern.compile("\\$\\[(.*?)\\]");
+  private static final Pattern VARIABLE_PATTERN = Pattern.compile("<([^>]+)>(.*?)</\\1>");
+
+  /**
+   * Tests the installation of {@link Mvn}
+   *
+   * @throws IOException if an I/O error occurs during the installation process
+   */
+  @Test
+  public void testMvnInstall() throws IOException {
+
+    // arrange
+    IdeTestContext context = newContext(PROJECT_MVN);
+    context.setInputValues(List.of("testLogin", "testPassword"));
+    InstallCommandlet install = context.getCommandletManager().getCommandlet(InstallCommandlet.class);
+    install.tool.setValueAsString("mvn", context);
+
+    // act
+    install.run();
+
+    // assert
+    checkInstallation(context);
+  }
+
+  /**
+   * Tests the execution of {@link Mvn}
+   *
+   * @throws IOException if an I/O error occurs during the installation process
+   */
+  @Test
+  public void testMvnRun() throws IOException {
+    // arrange
+    IdeTestContext context = newContext(PROJECT_MVN);
+    context.setInputValues(List.of("testLogin", "testPassword"));
+    InstallCommandlet install = context.getCommandletManager().getCommandlet(InstallCommandlet.class);
+    install.tool.setValueAsString("mvn", context);
+    Mvn commandlet = (Mvn) install.tool.getValue();
+    commandlet.arguments.addValue("foo");
+    commandlet.arguments.addValue("bar");
+
+    // act
+    commandlet.run();
+
+    // assert
+    assertLogMessage(context, IdeLogLevel.INFO, "mvn " + "foo bar");
+    checkInstallation(context);
+  }
+
+  private void checkInstallation(IdeTestContext context) throws IOException {
+
+    assertThat(context.getSoftwarePath().resolve("java/bin/java")).exists();
+
+    assertThat(context.getSoftwarePath().resolve("mvn/.ide.software.version")).exists().hasContent("3.9.7");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed mvn in version 3.9.7");
+
+    Path settingsFile = context.getConfPath().resolve(Mvn.MVN_CONFIG_FOLDER).resolve(Mvn.SETTINGS_FILE);
+    assertThat(settingsFile).exists();
+    assertFileContent(settingsFile, List.of("${env.M2_REPO}", "repository", "testLogin", "testPassword"));
+
+    Path settingsSecurityFile = context.getConfPath().resolve(Mvn.MVN_CONFIG_FOLDER).resolve(Mvn.SETTINGS_SECURITY_FILE);
+    assertThat(settingsSecurityFile).exists();
+    assertFileContent(settingsSecurityFile, List.of("masterPassword"));
+  }
+
+  private void assertFileContent(Path filePath, List<String> expectedValues) throws IOException {
+
+    String content = new String(Files.readAllBytes(filePath));
+    Matcher matcher = VARIABLE_PATTERN.matcher(content);
+    List<String> values = matcher.results().map(matchResult -> matchResult.group(2)).collect(Collectors.toList());
+
+    assertThat(values).containsExactlyInAnyOrderElementsOf(expectedValues);
+  }
+}

cli/src/test/resources/ide-projects/mvn/_ide/urls/readme

@@ -0,0 +1 @@
+this is the download metadata

cli/src/test/resources/ide-projects/mvn/project/home/readme

@@ -0,0 +1 @@
+this is the users HOME directory

cli/src/test/resources/ide-projects/mvn/project/readme

@@ -0,0 +1 @@
+this is the IDE_HOME directory

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

@@ -0,0 +1,2 @@
+JAVA_VERSION=17.0.10_7
+MVN_VERSION=3.9.7

cli/src/test/resources/ide-projects/mvn/project/settings/templates/conf/mvn/settings.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<settings>
+  <localRepository>${env.M2_REPO}</localRepository>
+
+  <servers>
+    <server>
+      <id>repository</id>
+      <username>$[login]</username>
+      <password>$[password]</password>
+    </server>
+  </servers>
+
+</settings>

cli/src/test/resources/ide-projects/mvn/project/workspaces/main/readme

@@ -0,0 +1 @@
+this is the main workspace of mvn test case

cli/src/test/resources/ide-projects/mvn/readme

@@ -0,0 +1 @@
+this is the IDE_ROOT directory

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

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

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

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+if [ "$1" == "--encrypt-master-password" ]; then
+    echo "masterPassword"
+elif [ "$1" == "--encrypt-password" ]; then
+    echo "$2"
+else
+    echo "mvn $*"
+fi