Add support for installing IntelliJ from .dmg (#283)

* Add support for installing IntelliJ from .dmg * Improve code style with try/finally and path resolving * Fix - restore String type for val dmgDir * update reference.conf user-facing comments * Update core/driver/sources/src/main/resources/reference.conf Co-authored-by: Paweł Lipski <[email protected]> * Update core/driver/sources/src/main/resources/reference.conf Co-authored-by: Paweł Lipski <[email protected]> * PR fixes - improve code style and fix logic * remove println Co-authored-by: Paweł Lipski <[email protected]>
VirtusLab · Oct 14, 2022 · 9d8d9a2 · 9d8d9a2
1 parent ac12752
commit 9d8d9a2
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 4 deletions.
diff --git a/core/driver/sources/src/main/resources/reference.conf b/core/driver/sources/src/main/resources/reference.conf
@@ -16,8 +16,10 @@ probe {
 
       // `ext` stands for the file extension (file format). This config specifies which extension should be
       // downloaded and installed. By default, ".zip" distributions of IntelliJ IDEA are downloaded. For now
-      // only ".zip" extension is supported.
+      // two extensions are supported: ".zip" and ".dmg". ".zip" is the default one whereas ".dmg" should be used
+      // for Mac OS X only.
       ext = ".zip"
+      # ext = ".dmg"
 
     }
 
@@ -96,8 +98,8 @@ probe {
     // ]
     //
     // Moreover, you can add a pattern pointing to a directory of an installed IntelliJ instance instead of
-    // pattern pointing to a .zip file. ide-probe will recognize if the pattern points to a directory with
-    // installed IntelliJ or to a .zip file. For example, if you run the IntelliJ Plugin Verifier on your
+    // pattern pointing to a .zip (or .dmg) file. ide-probe will recognize if the pattern points to a directory with
+    // installed IntelliJ or to a .zip (or .dmg) file. For example, if you run the IntelliJ Plugin Verifier on your
     // repository (https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runpluginverifier),
     // then you could use following configuration:
     // intellij.repositories = [

diff --git a/core/driver/sources/src/main/scala/org/virtuslab/ideprobe/dependencies/Resource.scala b/core/driver/sources/src/main/scala/org/virtuslab/ideprobe/dependencies/Resource.scala
@@ -15,6 +15,8 @@ import pureconfig.ConfigReader
 
 import org.virtuslab.ideprobe.ConfigFormat
 import org.virtuslab.ideprobe.Extensions._
+import org.virtuslab.ideprobe.OS
+import org.virtuslab.ideprobe.Shell
 
 sealed trait Resource
 
@@ -86,6 +88,31 @@ object Resource extends ConfigFormat {
     }
   }
 
+  final class DMGFile(val path: Path) extends IntellijResource {
+    def installTo(target: Path): Unit = {
+      // create tmp directory where disk image will be attached
+      val dmgDirPath = Paths.get(System.getProperty("java.io.tmpdir")).createDirectory("dmg_dir")
+      dmgDirPath.createDirectory()
+      val dmgDir = dmgDirPath.toString
+
+      try {
+        // attach disk image from .dmg file to local filesystem
+        Shell.run("hdiutil", "attach", "-mountpoint", dmgDir, path.toString).assertSuccess()
+        // copy $dmgDir/IntelliJ IDEA CE.app/ to proper installation directory
+        val appDir = dmgDirPath
+          .directChildren()
+          .find(path => path.name.startsWith("IntelliJ IDEA") && path.name.endsWith(".app"))
+          .get // appDir should point to an existing path. If not - `get` will throw NoSuchElementException
+        val idePath = Paths.get(s"$dmgDir/${appDir.name}/Contents")
+        idePath.copyDir(target)
+      } finally {
+        // detach disk image from local filesystem
+        Shell.run("hdiutil", "detach", dmgDir).assertSuccess()
+      }
+
+    }
+  }
+
   final class Plain(val path: Path) extends IntellijResource {
     def installTo(target: Path): Unit = {
       path.copyDir(target)
@@ -111,6 +138,12 @@ object Resource extends ConfigFormat {
     }
   }
 
+  object DMGFile {
+    def unapply(path: Path): Option[DMGFile] = {
+      if (path.toString.endsWith(".dmg") && OS.Current == OS.Mac) Some(new DMGFile(path)) else None
+    }
+  }
+
   object Plain {
     def unapply(path: Path): Option[Plain] = {
       if (path.isDirectory) Some(new Plain(path)) else None
@@ -120,6 +153,7 @@ object Resource extends ConfigFormat {
   implicit class ExtractorExtension(path: Path) {
     def toExtracted: IntellijResource = path match {
       case Archive(archive) => archive
+      case DMGFile(archive) => archive
       case Plain(archive)   => archive
       case _                => throw new IllegalStateException(s"Not an archive: $path")
     }

diff --git a/.../driver/sources/src/main/scala/org/virtuslab/ideprobe/dependencies/ResourceProvider.scala b/.../driver/sources/src/main/scala/org/virtuslab/ideprobe/dependencies/ResourceProvider.scala
@@ -4,6 +4,7 @@ import java.io.InputStream
 import java.net.URI
 import java.nio.file.Files
 import java.nio.file.Path
+import java.nio.file.Paths
 
 import scala.annotation.tailrec
 
@@ -73,7 +74,12 @@ object ResourceProvider {
     }
 
     private def cached(uri: URI): Path = {
-      directory.resolve(Hash.md5(uri.toString))
+      val resultPath = directory.resolve(Hash.md5(uri.toString))
+      val uriExtensionIndex = uri.toString.lastIndexOf('.')
+      if (uriExtensionIndex != -1)
+        Paths.get(resultPath.toString + uri.toString.substring(uriExtensionIndex)) // keep extension in cached file name
+      else
+        resultPath
     }
   }
 }