#25: implement tool commandlet for intellij

.gitattributes

@@ -5,4 +5,7 @@
 *.tgz binary
 *.tar binary
 *.bz2 binary
-*.gz binary
+*.gz binary
+
+# special handling for test files
+cli/src/test/resources/ide-projects/android-studio/repository/android-studio/android-studio/default/windows/bin/studio64.exe text

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

@@ -12,6 +12,7 @@
 import com.devonfw.tools.ide.tool.gh.Gh;
 import com.devonfw.tools.ide.tool.gradle.Gradle;
 import com.devonfw.tools.ide.tool.helm.Helm;
+import com.devonfw.tools.ide.tool.intellij.Intellij;
 import com.devonfw.tools.ide.tool.jasypt.Jasypt;
 import com.devonfw.tools.ide.tool.java.Java;
 import com.devonfw.tools.ide.tool.jmc.Jmc;
@@ -92,6 +93,7 @@ public CommandletManagerImpl(IdeContext context) {
     add(new Aws(context));
     add(new Cobigen(context));
     add(new Jmc(context));
+    add(new Intellij(context));
     add(new Jasypt(context));
     add(new Docker(context));
     add(new Sonar(context));

cli/src/main/java/com/devonfw/tools/ide/tool/intellij/Intellij.java

@@ -1,18 +1,32 @@
 package com.devonfw.tools.ide.tool.intellij;
 
-import java.util.Set;
-
+import com.devonfw.tools.ide.cli.CliArgument;
 import com.devonfw.tools.ide.common.Tag;
 import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.process.ProcessContext;
+import com.devonfw.tools.ide.process.ProcessErrorHandling;
+import com.devonfw.tools.ide.process.ProcessMode;
+import com.devonfw.tools.ide.process.ProcessResult;
+import com.devonfw.tools.ide.step.Step;
 import com.devonfw.tools.ide.tool.ide.IdeToolCommandlet;
 import com.devonfw.tools.ide.tool.ide.PluginDescriptor;
 import com.devonfw.tools.ide.tool.java.Java;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Set;
+
 /**
  * {@link IdeToolCommandlet} for <a href="https://www.jetbrains.com/idea/">IntelliJ</a>.
  */
 public class Intellij extends IdeToolCommandlet {
 
+  private static final String IDEA = "idea";
+
+  private static final String IDEA64_EXE = IDEA + "64.exe";
+
+  private static final String IDEA_BASH_SCRIPT = IDEA + ".sh";
+
   /**
    * The constructor.
    *
@@ -23,6 +37,60 @@ public Intellij(IdeContext context) {
     super(context, "intellij", Set.of(Tag.INTELLIJ));
   }
 
+  @Override
+  protected void runIde(String... args) {
+
+    install(true);
+
+    Step stepRun = this.context.newStep("Running IntelliJ");
+    try {
+      ProcessResult result;
+      if (this.context.getSystemInfo().isWindows()) {
+        result = runIntelliJ(ProcessMode.BACKGROUND, CliArgument.prepend(args, this.context.getWorkspacePath().toString()));
+      } else {
+        result = runIntelliJ(ProcessMode.BACKGROUND, CliArgument.prepend(args, "open", "-na", this.context.getWorkspacePath().toString()));
+      }
+      if (result.isSuccessful()) {
+        stepRun.success("Running IntelliJ successfully.");
+      } else {
+        stepRun.isFailure();
+      }
+    } catch (Exception e) {
+      stepRun.error(e, "Failed to run IntelliJ.");
+    } finally {
+      stepRun.end();
+    }
+  }
+
+  /**
+   * Runs IntelliJ application.
+   *
+   * @param processMode - the {@link ProcessMode}.
+   * @param args the individual arguments to pass to IntelliJ.
+   * @return the {@link ProcessResult}.
+   */
+  protected ProcessResult runIntelliJ(ProcessMode processMode, String... args) {
+
+    Path toolPath;
+    if (this.context.getSystemInfo().isWindows()) {
+      toolPath = getToolBinPath().resolve(IDEA64_EXE);
+    } else {
+      toolPath = getToolBinPath().resolve(IDEA_BASH_SCRIPT);
+      if (!Files.exists(toolPath)) {
+        toolPath = getToolPath().resolve(IDEA_BASH_SCRIPT);
+      }
+    }
+
+    ProcessContext pc = this.context.newProcess();
+    if (processMode == ProcessMode.DEFAULT_CAPTURE) {
+      pc.errorHandling(ProcessErrorHandling.ERROR);
+    }
+    pc.executable(toolPath);
+    pc.addArgs(args);
+
+    return pc.run(processMode);
+  }
+
   @Override
   public boolean install(boolean silent) {
 
@@ -33,8 +101,5 @@ public boolean install(boolean silent) {
   @Override
   public void installPlugin(PluginDescriptor plugin) {
 
-    // TODO Auto-generated method stub
-
   }
-
 }

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

@@ -17,6 +17,7 @@ cmd-gradle=Tool commandlet for Gradle (Build-Tool).
 cmd-helm=Tool commandlet for Helm (Kubernetes Package Manager).
 cmd-help=Prints this help.
 cmd-install=Install the selected tool.
+cmd-intellij=Tool commandlet for IntelliJ (IDE)
 cmd-update=update settings, software and repositories.
 cmd-java=Tool commandlet for Java (OpenJDK).
 cmd-jmc=Tool commandlet for JDK Mission Control.

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

@@ -16,6 +16,7 @@ cmd-gradle=Werkzeug Kommando für Gradle (Build-Tool).
 cmd-helm=Werkzeug Kommando für Helm (Kubernetes Package Manager).
 cmd-help=Zeigt diese Hilfe an.
 cmd-install=Installiert das selektierte Werkzeug.
+cmd-intellij=Werkzeug Kommando für Intellij (IDE)
 cmd-update=Updatet die Settings, Software und Repositories.
 cmd-create=Erstellt ein neues IDEasy Projekt.
 cmd-java=Werkzeug Kommando für Java (OpenJDK).

cli/src/test/java/com/devonfw/tools/ide/tool/intellij/IntellijTest.java

@@ -0,0 +1,80 @@
+package com.devonfw.tools.ide.tool.intellij;
+
+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.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+/**
+ * Integration test of {@link Intellij}.
+ */
+public class IntellijTest extends AbstractIdeContextTest {
+
+  private static final String PROJECT_INTELLIJ = "intellij";
+
+  private final IdeTestContext context = newContext(PROJECT_INTELLIJ);
+
+  /**
+   * Tests if the {@link Intellij} can be installed properly.
+   *
+   * @param os String of the OS to use.
+   */
+  @ParameterizedTest
+  @ValueSource(strings = { "windows", "mac", "linux" })
+  public void testIntellijInstall(String os) {
+
+    // arrange
+    SystemInfo systemInfo = SystemInfoMock.of(os);
+    context.setSystemInfo(systemInfo);
+    Intellij commandlet = new Intellij(context);
+
+    // act
+    commandlet.install();
+
+    // assert
+    checkInstallation(context);
+
+    //if tool already installed
+    commandlet.install();
+    assertLogMessage(context, IdeLogLevel.DEBUG, "Version 2023.3.3 of tool intellij is already installed");
+  }
+
+  /**
+   * Tests if {@link Intellij IntelliJ IDE} can be run.
+   *
+   * @param os String of the OS to use.
+   */
+  @ParameterizedTest
+  @ValueSource(strings = { "windows", "mac", "linux" })
+  public void testIntellijRun(String os) {
+    // arrange
+    SystemInfo systemInfo = SystemInfoMock.of(os);
+    context.setSystemInfo(systemInfo);
+    Intellij commandlet = new Intellij(context);
+
+    // act
+    commandlet.run();
+
+    // assert
+    SystemInfo currentSystemInfo = context.getSystemInfo();
+    if (currentSystemInfo.isMac()) {
+      assertLogMessage(context, IdeLogLevel.INFO, "intellij mac open -na " + context.getWorkspacePath());
+    } else if (currentSystemInfo.isLinux()) {
+      assertLogMessage(context, IdeLogLevel.INFO, "intellij linux open -na " + context.getWorkspacePath());
+    } else if (currentSystemInfo.isWindows()) {
+      assertLogMessage(context, IdeLogLevel.INFO, "intellij windows " + context.getWorkspacePath());
+    }
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Running IntelliJ successfully.");
+    checkInstallation(context);
+  }
+
+  private void checkInstallation(IdeTestContext context) {
+
+    assertThat(context.getSoftwarePath().resolve("intellij/.ide.software.version")).exists().hasContent("2023.3.3");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed java in version 17.0.10_7");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed intellij in version 2023.3.3");
+  }
+}

cli/src/test/java/com/devonfw/tools/ide/tool/npm/NpmTest.java

@@ -1,18 +1,25 @@
 package com.devonfw.tools.ide.tool.npm;
 
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.ValueSource;
-
 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.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
+/**
+ * Integration test of {@link Npm}.
+ */
 public class NpmTest extends AbstractIdeContextTest {
 
   private static final String PROJECT_NPM = "npm";
 
+  /**
+   * Tests if the {@link Npm} install works correctly across all three operating systems.
+   *
+   * @param os Operating system
+   */
   @ParameterizedTest
   @ValueSource(strings = { "windows", "mac", "linux" })
   public void testNpmInstall(String os) {
@@ -33,14 +40,10 @@ public void testNpmInstall(String os) {
   private void checkInstallation(IdeTestContext context) {
 
     if (context.getSystemInfo().isWindows()) {
-      assertThat(context.getSoftwarePath().resolve("node/npm")).exists()
-          .hasContent("#!/bin/bash\n" + "echo \"npmbin $*\"");
-      assertThat(context.getSoftwarePath().resolve("node/npm.cmd")).exists()
-          .hasContent("@echo off\n" + "echo npmcmdbin %*");
-      assertThat(context.getSoftwarePath().resolve("node/npx")).exists()
-          .hasContent("#!/bin/bash\n" + "echo \"npxbin $*\"");
-      assertThat(context.getSoftwarePath().resolve("node/npx.cmd")).exists()
-          .hasContent("@echo off\n" + "echo npxcmdbin %*");
+      assertThat(context.getSoftwarePath().resolve("node/npm")).exists().hasContent("#!/bin/bash\n" + "echo \"npmbin $*\"");
+      assertThat(context.getSoftwarePath().resolve("node/npm.cmd")).exists().hasContent("@echo off\n" + "echo npmcmdbin %*");
+      assertThat(context.getSoftwarePath().resolve("node/npx")).exists().hasContent("#!/bin/bash\n" + "echo \"npxbin $*\"");
+      assertThat(context.getSoftwarePath().resolve("node/npx.cmd")).exists().hasContent("@echo off\n" + "echo npxcmdbin %*");
     }
 
     assertThat(context.getSoftwarePath().resolve("npm/.ide.software.version")).exists().hasContent("9.9.2");

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

@@ -0,0 +1,2 @@
+JAVA_VERSION=17.0.10_7
+INTELLIJ_VERSION=2023.3.3

cli/src/test/resources/ide-projects/intellij/repository/intellij/intellij/default/linux/bin/idea.sh

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

cli/src/test/resources/ide-projects/intellij/repository/intellij/intellij/default/mac/bin/idea.sh

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

cli/src/test/resources/ide-projects/intellij/repository/intellij/intellij/default/windows/bin/idea64.exe

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