(#51) CI: download the PSES automatically

Author: ForNeVeR

.gitignore

@@ -1,4 +1,5 @@
 /language_host/current/LanguageHost/modules/PSScriptAnalyzer
+/language_host/current/LanguageHost/modules/PowerShellEditorServices
 /src/main/gen-parser
 /src/main/gen-lexer
 

build.gradle.kts

@@ -1,4 +1,5 @@
 import de.undercouch.gradle.tasks.download.Download
+import org.intellij.markdown.html.URI
 import org.jetbrains.intellij.tasks.PrepareSandboxTask
 import java.security.MessageDigest
 import java.util.zip.ZipFile
@@ -99,62 +100,107 @@ tasks {
     kotlinOptions.jvmTarget = "17"
   }
 
-  val downloads = layout.buildDirectory.get().dir("download")
-
-  val psScriptAnalyzerVersion: String by project
-  val psScriptAnalyzerSha256Hash: String by project
-
-  val psScriptAnalyzerFileName = "PSScriptAnalyzer.$psScriptAnalyzerVersion.nupkg"
-  val psScriptAnalyzerOutFile = downloads.file(psScriptAnalyzerFileName)
-
-  val downloadPsScriptAnalyzer by register<Download>("downloadPsScriptAnalyzer") {
-    group = "dependencies"
-
-    inputs.property("version", psScriptAnalyzerVersion)
-    inputs.property("hash", psScriptAnalyzerSha256Hash)
-
-    // NOTE: Do not overwrite: the verification step should delete an incorrect file.
-    // NOTE: Notably, this property allows us to skip the task completely if no inputs change.
-    overwrite(false)
+  fun getDependencyTask(
+    dependencyName: String,
+    version: String,
+    expectedHash: String,
+    uri: URI,
+    destination: RegularFile,
+    customizeZip: Action<CopySpec>
+  ): TaskProvider<Copy> {
+    val download by register<Download>("download$dependencyName") {
+      group = "dependencies"
+
+      inputs.property("version", version)
+      inputs.property("hash", expectedHash)
+
+      // NOTE: Do not overwrite: the verification step should delete an incorrect file.
+      // NOTE: Notably, this property allows us to skip the task completely if no inputs change.
+      overwrite(false)
+
+      src(uri)
+      dest(destination)
+
+      doLast {
+        val data = destination.asFile.readBytes()
+        val hash = MessageDigest.getInstance("SHA-256").let { sha256 ->
+          sha256.update(data)
+          sha256.digest().joinToString("") { "%02x".format(it) }
+        }
+        if (!hash.equals(expectedHash, ignoreCase = true)) {
+          destination.asFile.toPath().deleteExisting()
+          error("$dependencyName hash check failed. Expected $expectedHash, but got $hash\n" +
+            "The downloaded file has been deleted.\n" +
+            "Please try running the task again, or update the expected hash in the gradle.properties file.")
+        }
+      }
+    }
 
-    src("https://github.com/PowerShell/PSScriptAnalyzer/releases/download/" +
-      "$psScriptAnalyzerVersion/$psScriptAnalyzerFileName")
-    dest(psScriptAnalyzerOutFile)
+    return register<Copy>("get$dependencyName") {
+      group = "dependencies"
 
-    doLast {
-      val data = psScriptAnalyzerOutFile.asFile.readBytes()
-      val hash = MessageDigest.getInstance("SHA-256").let { sha256 ->
-        sha256.update(data)
-        sha256.digest().joinToString("") { "%02x".format(it) }
+      val outDir = projectDir.resolve("language_host/current/LanguageHost/modules/$dependencyName")
+      doFirst {
+        if (!outDir.deleteRecursively()) error("Cannot delete \"$outDir\".")
       }
-      if (!hash.equals(psScriptAnalyzerSha256Hash, ignoreCase = true)) {
-        psScriptAnalyzerOutFile.asFile.toPath().deleteExisting()
-        error("PSScriptAnalyzer hash check failed. Expected ${psScriptAnalyzerSha256Hash}, but got $hash\n" +
-          "Please try running the task again, or update the expected hash in the gradle.properties file.")
+
+      dependsOn(download)
+      from(zipTree(destination)) {
+        customizeZip(this)
       }
+      into(outDir)
     }
   }
 
-  val getPsScriptAnalyzer by registering(Copy::class) {
-    group = "dependencies"
+  val downloads = layout.buildDirectory.get().dir("download")
 
-    val outDir = projectDir.resolve("language_host/current/LanguageHost/modules/PSScriptAnalyzer")
-    doFirst {
-      if (!outDir.deleteRecursively()) error("Cannot delete \"$outDir\".")
-    }
+  val psScriptAnalyzerVersion: String by project
+  val psScriptAnalyzerSha256Hash: String by project
+  val psScriptAnalyzerFileName = "PSScriptAnalyzer.$psScriptAnalyzerVersion.nupkg"
+  val psScriptAnalyzerOutFile = downloads.file(psScriptAnalyzerFileName)
 
-    dependsOn(downloadPsScriptAnalyzer)
-    from(zipTree(psScriptAnalyzerOutFile))
+  val psesVersion: String by project
+  val psesSha256Hash: String by project
+
+  val getPsScriptAnalyzer = getDependencyTask(
+    "PSScriptAnalyzer",
+    psScriptAnalyzerVersion,
+    psScriptAnalyzerSha256Hash,
+    URI(
+      "https://github.com/PowerShell/PSScriptAnalyzer/releases/download/" +
+        "$psScriptAnalyzerVersion/$psScriptAnalyzerFileName"
+    ),
+    psScriptAnalyzerOutFile
+  ) {
     // NuGet stuff:
     exclude("_manifest/**", "_rels/**", "package/**", "[Content_Types].xml", "*.nuspec")
 
     // Compatibility profiles, see https://github.com/PowerShell/PSScriptAnalyzer/issues/1148
     exclude("compatibility_profiles/**")
-    into(outDir)
+  }
+
+  val getPowerShellEditorServices = getDependencyTask(
+    "PowerShellEditorServices",
+    psesVersion,
+    psesSha256Hash,
+    URI(
+      "https://github.com/PowerShell/PowerShellEditorServices/releases/download/" +
+        "v$psesVersion/PowerShellEditorServices.zip"
+    ),
+    downloads.file("PowerShellEditorServices.zip")
+  ) {
+    include("PowerShellEditorServices/PowerShellEditorServices/**")
+    eachFile {
+      relativePath = RelativePath(true, *relativePath.segments.drop(2).toTypedArray())
+    }
+  }
+
+  val getAllDependencies by registering {
+    dependsOn(getPsScriptAnalyzer, getPowerShellEditorServices)
   }
 
   withType<PrepareSandboxTask> {
-    dependsOn(getPsScriptAnalyzer)
+    dependsOn(getAllDependencies)
     from("${project.rootDir}/language_host/current") {
       into("${intellij.pluginName.get()}/lib/")
     }

gradle.properties

@@ -5,3 +5,6 @@ maxUnpackedPluginBytes=20971520
 
 psScriptAnalyzerVersion=1.21.0
 psScriptAnalyzerSha256Hash=66353f139f4f1ffaa532fdeed965e70afbb8400b4810b6b2b91e091119aa6fad
+
+psesVersion=1.10.1
+psesSha256Hash=1c2ec9bbe40142df370497f72a8c33aafa8328462f204b4e1c5986ea7a59a40e