#12: Implement ToolCommandlet for Android Studio

.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

@@ -3,6 +3,7 @@
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.property.KeywordProperty;
 import com.devonfw.tools.ide.property.Property;
+import com.devonfw.tools.ide.tool.androidstudio.AndroidStudio;
 import com.devonfw.tools.ide.tool.aws.Aws;
 import com.devonfw.tools.ide.tool.az.Azure;
 import com.devonfw.tools.ide.tool.cobigen.Cobigen;
@@ -96,6 +97,7 @@ public CommandletManagerImpl(IdeContext context) {
     add(new Jasypt(context));
     add(new Docker(context));
     add(new Sonar(context));
+    add(new AndroidStudio(context));
     add(new GraalVm(context));
   }
 

cli/src/main/java/com/devonfw/tools/ide/io/FileAccessImpl.java

@@ -652,7 +652,7 @@ public void extractDmg(Path file, Path targetDir) {
     if (appPath == null) {
       throw new IllegalStateException("Failed to unpack DMG as no MacOS *.app was found in file " + file);
     }
-    copy(appPath, targetDir);
+    copy(appPath, targetDir, FileCopyMode.COPY_TREE_OVERRIDE_TREE);
     pc.addArgs("detach", "-force", mountPath);
     pc.run();
   }

cli/src/main/java/com/devonfw/tools/ide/tool/androidstudio/AndroidStudio.java

@@ -0,0 +1,108 @@
+package com.devonfw.tools.ide.tool.androidstudio;
+
+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 java.nio.file.Path;
+import java.util.Set;
+
+/**
+ * {@link IdeToolCommandlet} for <a href="https://developer.android.com/studio">AndroidStudio</a>.
+ */
+public class AndroidStudio extends IdeToolCommandlet {
+
+  private static final String STUDIO = "studio";
+
+  private static final String STUDIO64_EXE = STUDIO + "64.exe";
+
+  private static final String STUDIO_BASH = STUDIO + ".sh";
+
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   */
+  public AndroidStudio(IdeContext context) {
+
+    super(context, "android-studio", Set.of(Tag.ANDROID_STUDIO));
+  }
+
+  @Override
+  protected void runIde(String... args) {
+
+    install(true);
+
+    Step stepRun = this.context.newStep("Running Android Studio");
+    try {
+      ProcessResult result;
+      if (this.context.getSystemInfo().isMac()) {
+        Path studioPath = getToolPath().resolve("Contents").resolve("MacOS").resolve(STUDIO);
+        result = runAndroidStudio(ProcessMode.BACKGROUND,
+            CliArgument.prepend(args, "-na", studioPath.toString(), "--args", this.context.getWorkspacePath().toString()));
+      } else {
+        result = runAndroidStudio(ProcessMode.BACKGROUND, CliArgument.prepend(args, this.context.getWorkspacePath().toString()));
+      }
+
+      if (result.isSuccessful()) {
+        stepRun.success("Running Android Studio successfully.");
+      } else {
+        stepRun.isFailure();
+      }
+
+    } catch (Exception e) {
+      stepRun.error(e, "Failed to run Android Studio.");
+    } finally {
+      stepRun.end();
+    }
+
+  }
+
+  /**
+   * Runs the Android Studio application.
+   *
+   * @param processMode - the {@link ProcessMode}.
+   * @param args the individual arguments to pass to Android Studio.
+   * @return the {@link ProcessResult}.
+   */
+  private ProcessResult runAndroidStudio(ProcessMode processMode, String... args) {
+
+    Path toolPath;
+    if (this.context.getSystemInfo().isWindows()) {
+      toolPath = getToolBinPath().resolve(STUDIO64_EXE);
+    } else if (this.context.getSystemInfo().isLinux()) {
+      toolPath = getToolBinPath().resolve(STUDIO_BASH);
+    } else {
+      toolPath = Path.of("open");
+    }
+
+    ProcessContext pc = this.context.newProcess();
+
+    pc.executable(toolPath);
+
+    if (processMode == ProcessMode.DEFAULT_CAPTURE) {
+      pc.errorHandling(ProcessErrorHandling.ERROR);
+    }
+    pc.addArgs(args);
+
+    return pc.run(processMode);
+  }
+
+  @Override
+  public boolean install(boolean silent) {
+
+    return super.install(silent);
+  }
+
+  @Override
+  public void installPlugin(PluginDescriptor plugin) {
+
+  }
+}

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

@@ -2,6 +2,7 @@ usage=Usage:
 values=Values:
 commandlets=Available commandlets:
 options=Options:
+cmd-android-studio=Tool commandlet for Android Studio (IDE).
 cmd-aws=Tool commandlet for AWS CLI.
 cmd-az=Tool commandlet for Azure CLI.
 cmd---version=Print the version of IDEasy.

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

@@ -2,6 +2,7 @@ usage=Verwendung:
 values=Werte:
 commandlets=Verfügbare Kommandos:
 options=Optionen:
+cmd-android-studio=Werkzeug Kommando für Android Studio (IDE).
 cmd-aws=Werkzeug Kommando für AWS Kommandoschnittstelle.
 cmd-az=Werkzeug Kommando für Azure Kommandoschnittstelle.
 cmd---version=Gibt die Version von IDEasy aus.

cli/src/test/java/com/devonfw/tools/ide/tool/androidstudio/AndroidStudioTest.java

@@ -0,0 +1,76 @@
+package com.devonfw.tools.ide.tool.androidstudio;
+
+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;
+
+/**
+ * Test class for {@link AndroidStudio Android Studio IDE} tests.
+ */
+public class AndroidStudioTest extends AbstractIdeContextTest {
+
+  private static final String ANDROID_STUDIO = "android-studio";
+
+  private final IdeTestContext context = newContext(ANDROID_STUDIO);
+
+  /**
+   * Tests if {@link AndroidStudio Android Studio IDE} can be installed.
+   *
+   * @param os String of the OS to use.
+   */
+  @ParameterizedTest
+  @ValueSource(strings = { "windows", "mac", "linux" })
+  public void testAndroidStudioInstall(String os) {
+    // arrange
+    SystemInfo systemInfo = SystemInfoMock.of(os);
+    this.context.setSystemInfo(systemInfo);
+    AndroidStudio commandlet = new AndroidStudio(this.context);
+
+    // act
+    commandlet.install();
+
+    // assert
+    checkInstallation(this.context);
+  }
+
+  /**
+   * Tests if {@link AndroidStudio Android Studio IDE} can be run.
+   *
+   * @param os String of the OS to use.
+   */
+  @ParameterizedTest
+  @ValueSource(strings = { "windows", "mac", "linux" })
+  public void testAndroidStudioRun(String os) {
+    // arrange
+    SystemInfo systemInfo = SystemInfoMock.of(os);
+    this.context.setSystemInfo(systemInfo);
+    AndroidStudio commandlet = new AndroidStudio(this.context);
+
+    // act
+    commandlet.run();
+
+    // assert
+    if (this.context.getSystemInfo().isMac()) {
+      assertLogMessage(this.context, IdeLogLevel.INFO,
+          ANDROID_STUDIO + " mac -na " + commandlet.getToolPath().resolve("Contents/MacOS/studio") + " --args " + this.context.getWorkspacePath());
+    } else if (this.context.getSystemInfo().isLinux()) {
+      assertLogMessage(this.context, IdeLogLevel.INFO, ANDROID_STUDIO + " linux " + this.context.getWorkspacePath());
+    } else if (this.context.getSystemInfo().isWindows()) {
+      assertLogMessage(this.context, IdeLogLevel.INFO, ANDROID_STUDIO + " windows " + this.context.getWorkspacePath());
+    }
+
+    assertLogMessage(this.context, IdeLogLevel.SUCCESS, "Running Android Studio successfully.");
+    checkInstallation(this.context);
+  }
+
+  private void checkInstallation(IdeTestContext context) {
+    // commandlet - android-studio
+    assertThat(context.getSoftwarePath().resolve("android-studio/.ide.software.version")).exists().hasContent("2024.1.1.1");
+    assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed android-studio in version 2024.1.1.1");
+  }
+
+}

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

@@ -0,0 +1 @@
+ANDROID-STUDIO_VERSION=2024.1.1.1

cli/src/test/resources/ide-projects/android-studio/repository/android-studio/android-studio/default/linux/bin/studio.sh

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

cli/src/test/resources/ide-projects/android-studio/repository/android-studio/android-studio/default/mac/bin/open

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

cli/src/test/resources/ide-projects/android-studio/repository/android-studio/android-studio/default/windows/bin/studio64.exe

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