#26: Implement ToolCommandlet for Jasypt

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

@@ -27,6 +27,7 @@
 import com.devonfw.tools.ide.tool.quarkus.Quarkus;
 import com.devonfw.tools.ide.tool.terraform.Terraform;
 import com.devonfw.tools.ide.tool.vscode.Vscode;
+import com.devonfw.tools.ide.tool.jasypt.Jasypt;
 
 /**
  * Implementation of {@link CommandletManager}.
@@ -83,6 +84,7 @@ public CommandletManagerImpl(IdeContext context) {
     add(new Aws(context));
     add(new Cobigen(context));
     add(new Jmc(context));
+    add(new Jasypt(context));
   }
 
   private void add(Commandlet commandlet) {

cli/src/main/java/com/devonfw/tools/ide/tool/jasypt/Jasypt.java

@@ -0,0 +1,104 @@
+package com.devonfw.tools.ide.tool.jasypt;
+
+import com.devonfw.tools.ide.common.Tag;
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.tool.LocalToolCommandlet;
+import com.devonfw.tools.ide.tool.ToolCommandlet;
+import com.devonfw.tools.ide.tool.java.Java;
+import com.devonfw.tools.ide.tool.mvn.Mvn;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Set;
+
+/**
+ * {@link ToolCommandlet} for <a href="http://www.jasypt.org/">Jasypt</a>, The java library which allows to add basic
+ * encryption capabilities with minimum effort.
+ */
+public class Jasypt extends LocalToolCommandlet {
+
+  private static final String USAGE_INFO = """
+      Jasypt encryption tool
+      Usage:
+       encrypt  <masterpassword>  <secret>             encrypt a secret with a master-password
+       decrypt  <masterpassword>  <secret>             decrypt an encrypted secret with a master-password
+      """;
+
+  private static final String CLASS_NAME_ENCRYPTION = "org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI";
+
+  private static final String CLASS_NAME_DECRYPTION = "org.jasypt.intf.cli.JasyptPBEStringDecryptionCLI";
+
+  private static final String ALGORITHM = "algorithm=PBEWITHHMACSHA512ANDAES_256";
+
+  private static final String GENERATOR_CLASS_NAME = "ivGeneratorClassName=org.jasypt.iv.RandomIvGenerator";
+
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   */
+  public Jasypt(IdeContext context) {
+
+    super(context, "jasypt", Set.of(Tag.JAVA));
+  }
+
+  @Override
+  public void run() {
+
+    String[] args = this.arguments.asArray();
+
+    if (args.length == 0) {
+      this.context.info(USAGE_INFO);
+    } else if (args.length == 3 && args[0].equals("encrypt")) {
+      runJasypt(CLASS_NAME_ENCRYPTION, args);
+    } else if (args.length == 3 && args[0].equals("decrypt")) {
+      runJasypt(CLASS_NAME_DECRYPTION, args);
+    } else {
+      this.context.warning("Unknown arguments");
+      this.context.info(USAGE_INFO);
+    }
+  }
+
+  @Override
+  public boolean doInstall(boolean silent) {
+
+    getCommandlet(Java.class).install();
+
+    return super.doInstall(silent);
+  }
+
+  @Override
+  public void postInstall() {
+
+    super.postInstall();
+
+    if (Files.notExists(resolveJasyptJarPath())) {
+      installJasyptArtifact();
+    }
+  }
+
+  private void installJasyptArtifact() {
+
+    Mvn mvn = getCommandlet(Mvn.class);
+    mvn.install();
+    this.context.debug("installing jasypt artifact in: " + resolveJasyptJarPath());
+    mvn.runTool(null, "org.apache.maven.plugins:maven-dependency-plugin:3.1.2:get",
+        "-Dartifact=org.jasypt:jasypt:" + getInstalledVersion().toString());
+  }
+
+  private void runJasypt(String className, String[] args) {
+
+    Java java = getCommandlet(Java.class);
+    java.runTool(null, "-cp", resolveJasyptJarPath().toString(), className, ALGORITHM, GENERATOR_CLASS_NAME,
+        "password=" + args[1], "input=" + args[2]);
+  }
+
+  private Path resolveJasyptJarPath() {
+
+    Path m2Repo = context.getVariables().getPath("M2_REPO");
+    String installedVersion = getInstalledVersion().toString();
+    return m2Repo.resolve("org").resolve("jasypt").resolve("jasypt").resolve(installedVersion)
+        .resolve("jasypt-" + installedVersion + ".jar");
+  }
+
+}

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

@@ -32,6 +32,7 @@ cmd-shell=Commandlet to start built-in shell with advanced auto-completion.
 cmd-terraform=Tool commandlet for Terraform
 cmd-vscode=Tool commandlet for Visual Studio Code (IDE)
 cmd-cobigen=Tool commandlet for Cobigen
+cmd-jasypt=Tool commandlet for Jasypt
 val-args=The commandline arguments to pass to the tool.
 val-edition=The tool edition.
 val-tool=The tool commandlet to select.

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

@@ -29,6 +29,7 @@ cmd-set-version=Setzt die Version des selektierten Werkzeugs.
 cmd-terraform=Werkzeug Kommando für Terraform.
 cmd-vscode=Werkzeug Kommando für Visual Studio Code (IDE)
 cmd-cobigen=Werkzeug Kommando für Cobigen.
+cmd-jasypt=Werkzeug Kommando für Jasypt
 val-args=Die Kommandozeilen-Argumente zur Übergabe an das Werkzeug.
 val-edition=Die Werkzeug Edition.
 val-tool=Das zu selektierende Werkzeug Kommando.

cli/src/test/java/com/devonfw/tools/ide/tool/jasypt/JasyptTest.java

@@ -0,0 +1,80 @@
+package com.devonfw.tools.ide.tool.jasypt;
+
+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.util.List;
+
+/**
+ * Integration test of {@link Jasypt}.
+ */
+public class JasyptTest extends AbstractIdeContextTest {
+
+  private static final String PROJECT_JASYPT = "jasypt";
+
+  @Test
+  public void testJasypt() {
+
+    // arrange
+    IdeTestContext context = newContext(PROJECT_JASYPT);
+    Jasypt commandlet = new Jasypt(context);
+
+    // act - install
+    commandlet.install();
+
+    // assert - install
+    checkInstallation(context);
+
+    // act and assert - run
+    runNoArgs(context, commandlet, null);
+    runRightArgs(context, commandlet, List.of("encrypt", "master", "secret"));
+    runRightArgs(context, commandlet, List.of("decrypt", "master", "secret"));
+    runWrongArgs(context, commandlet, List.of("wrong args"));
+  }
+
+  public void runNoArgs(IdeTestContext context, Jasypt commandlet, List<String> arguments) {
+
+    String expectedMessage = """
+        Jasypt encryption tool
+        Usage:
+         encrypt  <masterpassword>  <secret>             encrypt a secret with a master-password
+         decrypt  <masterpassword>  <secret>             decrypt an encrypted secret with a master-password
+        """;
+    commandlet.arguments.setValue(arguments);
+    commandlet.run();
+    assertLogMessage(context, IdeLogLevel.INFO, expectedMessage);
+  }
+
+  public void runWrongArgs(IdeTestContext context, Jasypt commandlet, List<String> arguments) {
+
+    commandlet.arguments.setValue(arguments);
+    commandlet.run();
+    assertLogMessage(context, IdeLogLevel.WARNING, "Unknown arguments");
+  }
+
+  public void runRightArgs(IdeTestContext context, Jasypt commandlet, List<String> arguments) {
+
+    commandlet.arguments.setValue(arguments);
+    commandlet.run();
+    assertLogMessage(context, IdeLogLevel.INFO, "executing java:");
+  }
+
+  private void checkInstallation(IdeTestContext context) {
+
+    // install - java
+    assertThat(context.getSoftwarePath().resolve("java/bin/java")).exists();
+
+    // postInstall - mvn
+    assertLogMessage(context, IdeLogLevel.INFO, "executing mvn:");
+    assertThat(context.getSoftwarePath().resolve("mvn/bin/mvn")).exists();
+
+    // commandlet - jasypt
+    assertThat(context.getSoftwarePath().resolve("jasypt/META-INF/HelloWorld.txt")).hasContent("Hello World!");
+    assertThat(context.getSoftwarePath().resolve("jasypt/org/HelloWorld.txt")).hasContent("Hello World!");
+    assertThat(context.getSoftwarePath().resolve("jasypt/.ide.software.version")).exists().hasContent("1.9.3");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed jasypt in version 1.9.3");
+  }
+
+}

cli/src/test/resources/ide-projects/jasypt/_ide/urls/jasypt/jasypt/1.9.3/status.json

@@ -0,0 +1,10 @@
+{
+  "manual" : false,
+  "urls" : {
+    "55042423" : {
+      "success" : {
+        "timestamp" : "2024-02-13T17:38:27.770091500Z"
+      }
+    }
+  }
+}

cli/src/test/resources/ide-projects/jasypt/_ide/urls/jasypt/jasypt/1.9.3/urls

@@ -0,0 +1 @@
+https://repo1.maven.org/maven2/org/jasypt/jasypt/1.9.3/jasypt-1.9.3.jar

cli/src/test/resources/ide-projects/jasypt/_ide/urls/jasypt/jasypt/1.9.3/urls.sha256

@@ -0,0 +1 @@
+f481fbb8dd8ce754bfde7552af4fcbe8c5e303d53663bb3d8ce9d4338e0e55aa

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/linux_x64.sha256

@@ -0,0 +1 @@
+c2de7dfbd9f8faaa21b4cdd8518f826dd558c9ab24a0616b3ed28437a674a97b

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/linux_x64.urls

@@ -0,0 +1 @@
+http://localhost:1112/installTest/linux

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/mac_x64.sha256

@@ -0,0 +1 @@
+c2de7dfbd9f8faaa21b4cdd8518f826dd558c9ab24a0616b3ed28437a674a97b

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/mac_x64.urls

@@ -0,0 +1 @@
+http://localhost:1112/installTest/macOS

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/status.json

@@ -0,0 +1,20 @@
+{
+  "manual" : true,
+  "urls" : {
+    "-680270697" : {
+      "success" : {
+        "timestamp" : "2023-04-28T16:27:32.819394600Z"
+      }
+    },
+    "-896197542" : {
+      "success" : {
+        "timestamp" : "2023-04-28T16:27:47.658175400Z"
+      }
+    },
+    "-310367019" : {
+      "success" : {
+        "timestamp" : "2023-04-28T16:28:02.221367500Z"
+      }
+    }
+  }
+}

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/windows_x64.urls

@@ -0,0 +1 @@
+http://localhost:1112/installTest/windows

cli/src/test/resources/ide-projects/jasypt/_ide/urls/java/java/17.0.6/windows_x64.urls.sha256

@@ -0,0 +1 @@
+aa64bee5f7ba56fbbd60d766f3a652600f81571ae5e996804694c69bf731af8b

cli/src/test/resources/ide-projects/jasypt/_ide/urls/mvn/mvn/3.9.6/status.json

@@ -0,0 +1,10 @@
+{
+  "manual" : false,
+  "urls" : {
+    "1199796863" : {
+      "success" : {
+        "timestamp" : "2023-12-02T03:34:21.698982214Z"
+      }
+    }
+  }
+}

cli/src/test/resources/ide-projects/jasypt/_ide/urls/mvn/mvn/3.9.6/urls

@@ -0,0 +1 @@
+https://archive.apache.org/dist/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.tar.gz

cli/src/test/resources/ide-projects/jasypt/_ide/urls/mvn/mvn/3.9.6/urls.sha256

@@ -0,0 +1 @@
+6eedd2cae3626d6ad3a5c9ee324bd265853d64297f07f033430755bd0e0c3a4b

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+JAVA_VERSION=17.0.10_7
+JASYPT_VERSION=1.9.3
+JMC_VERSION=8.3.0
+MVN_VERSION=3.9.6
+
+M2_REPO=~/.m2/repository

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

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

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

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

cli/src/test/resources/ide-projects/jasypt/repository/jasypt/jasypt/default/InstallTest.txt

@@ -0,0 +1 @@
+This is a test file.

cli/src/test/resources/ide-projects/jasypt/repository/jasypt/jasypt/default/META-INF/HelloWorld.txt

@@ -0,0 +1 @@
+Hello World!

cli/src/test/resources/ide-projects/jasypt/repository/jasypt/jasypt/default/org/HelloWorld.txt

@@ -0,0 +1 @@
+Hello World!

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

@@ -0,0 +1,3 @@
+#!/bin/bash
+echo "executing java:"
+echo "java $*"

cli/src/test/resources/ide-projects/jasypt/repository/java/java/default/bin/java.cmd

@@ -0,0 +1,3 @@
+@echo off
+echo executing java:
+echo java %*

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

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

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

@@ -0,0 +1,3 @@
+@echo off
+echo executing mvn:
+echo mvn %*