Refactoring delphi cli sttp dependency for native image generation

Author: Hariharan Ramanathan

build.sbt

@@ -29,6 +29,11 @@ libraryDependencies += "com.lihaoyi" %% "fansi" % "0.2.5"
 libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value
 libraryDependencies += "au.com.bytecode" % "opencsv" % "2.4"
 
+
+libraryDependencies += "com.softwaremill.sttp" %% "core" % "1.5.4"
+
+
+
 debianPackageDependencies := Seq("java8-runtime-headless")
 
 lazy val cli = (project in file(".")).
@@ -38,11 +43,23 @@ lazy val cli = (project in file(".")).
   enablePlugins(BuildInfoPlugin).
   enablePlugins(DebianPlugin).
   enablePlugins(WindowsPlugin).
-
+  enablePlugins(GraalVMNativeImagePlugin).
+  settings(
+    graalVMNativeImageOptions++=Seq(
+      "--enable-https",
+      "--enable-http",
+      "--enable-all-security-services",
+      "--allow-incomplete-classpath",
+      "--enable-url-protocols=http,https"
+    )
+  ).
+  enablePlugins(JDKPackagerPlugin).
   settings(
     buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
-    buildInfoPackage := "de.upb.cs.swt.delphi.cli"
+    buildInfoPackage := "de.upb.cs.swt.delphi.cli",
   )
 scalastyleConfig := baseDirectory.value / "project" / "scalastyle-config.xml"
 
 trapExit := false
+fork := true
+connectInput := true

project/build.properties

@@ -1 +1 @@
-sbt.version = 1.1.1
+sbt.version = 1.2.8

project/plugins.sbt

@@ -1,6 +1,6 @@
 // build management and packaging
 addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.7.0")
-addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.15")
 
 // coverage
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")

src/main/scala/de/upb/cs/swt/delphi/cli/Config.scala

@@ -23,7 +23,7 @@ package de.upb.cs.swt.delphi.cli
   * @param verbose Marker if logging should be verbose
   * @param mode    The command to be run
   */
-case class Config(server: String = sys.env.getOrElse("DELPHI_SERVER", "https://delphi.cs.uni-paderborn.de/api/"),
+case class Config(server: String = sys.env.getOrElse("DELPHI_SERVER", "https://delphi.cs.uni-paderborn.de/api"),
                   verbose: Boolean = false,
                   raw: Boolean = false,
                   csv: String = "",

src/main/scala/de/upb/cs/swt/delphi/cli/DelphiCLI.scala

@@ -16,81 +16,71 @@
 
 package de.upb.cs.swt.delphi.cli
 
-import akka.actor.ActorSystem
-import akka.http.scaladsl.Http
-import de.upb.cs.swt.delphi.cli.commands.{RetrieveCommand, SearchCommand, TestCommand}
-
-import scala.concurrent.duration.Duration
-import scala.concurrent.{Await, ExecutionContext}
-
+import de.upb.cs.swt.delphi.cli.commands.TestCommand
 
 /**
   * The application class for the Delphi command line interface
   */
-object DelphiCLI extends App {
-
-  implicit val system = ActorSystem()
+object DelphiCLI {
 
-  val cliParser = {
-    new scopt.OptionParser[Config]("delphi-cli") {
-      head("Delphi Command Line Tool", s"(${BuildInfo.version})")
+  private def cliParser = {
+    val parser = {
+      new scopt.OptionParser[Config]("delphi-cli") {
+        head("Delphi Command Line Tool", s"(${BuildInfo.version})")
 
-      version("version").text("Prints the version of the command line tool.")
+        version("version").text("Prints the version of the command line tool.")
 
-      help("help").text("Prints this help text.")
-      override def showUsageOnError = true
+        help("help").text("Prints this help text.")
 
-      opt[String]("server").action( (x,c) => c.copy(server = x)).text("The url to the Delphi server")
-      opt[Unit] (name = "raw").action((_,c) => c.copy(raw = true)).text("Output the raw results")
-      opt[Unit] (name = "silent").action((_,c) => c.copy(silent = true)).text("Suppress non-result output")
+        override def showUsageOnError = true
 
-      checkConfig(c => if (c.server.isEmpty()) failure("Option server is required.") else success)
+        opt[String]("server").action((x, c) => c.copy(server = x)).text("The url to the Delphi server")
+        opt[Unit](name = "raw").action((_, c) => c.copy(raw = true)).text("Output the raw results")
+        opt[Unit](name = "silent").action((_, c) => c.copy(silent = true)).text("Suppress non-result output")
 
-      cmd("test").action((_,c) => c.copy(mode = "test"))
+        checkConfig(c => if (c.server.isEmpty()) failure("Option server is required.") else success)
 
-      cmd("retrieve").action((s,c) => c.copy(mode = "retrieve"))
-        .text("Retrieve a project's description, specified by ID.")
-        .children(
-          arg[String]("id").action((x, c) => c.copy(id = x)).text("The ID of the project to retrieve"),
-          opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)"),
-          opt[Unit]('f', "file").action((_, c) => c.copy(opts = List("file"))).text("Use to load the ID from file, " +
-            "with the filepath given in place of the ID")
-        )
-
-      cmd("search").action((s, c) => c.copy(mode = "search"))
-        .text("Search artifact using a query.")
-        .children(
-          arg[String]("query").action((x,c) => c.copy(query = x)).text("The query to be used."),
-          opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)"),
-          opt[Int]("limit").action((x, c) => c.copy(limit = Some(x))).text("The maximal number of results returned."),
-          opt[Unit](name="list").action((_, c) => c.copy(list = true)).text("Output results as list (raw option overrides this)"),
-          opt[Int]("timeout").action((x, c) => c.copy(timeout = Some(x))).text("Timeout in seconds.")
-        )
-    }
-  }
+        cmd("test").action((_, c) => c.copy(mode = "test"))
 
+        cmd("retrieve").action((s, c) => c.copy(mode = "retrieve"))
+          .text("Retrieve a project's description, specified by ID.")
+          .children(
+            arg[String]("id").action((x, c) => c.copy(id = x)).text("The ID of the project to retrieve"),
+            opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)"),
+            opt[Unit]('f', "file").action((_, c) => c.copy(opts = List("file"))).text("Use to load the ID from file, " +
+              "with the filepath given in place of the ID")
+          )
 
-  cliParser.parse(args, Config()) match {
-    case Some(config) =>
-      if (!config.silent) cliParser.showHeader()
-      config.mode match {
-        case "test" => TestCommand.execute(config)
-        case "retrieve" => RetrieveCommand.execute(config)
-        case "search" => SearchCommand.execute(config)
-        case x => config.consoleOutput.outputError(s"Unknown command: $x")
+        cmd("search").action((s, c) => c.copy(mode = "search"))
+          .text("Search artifact using a query.")
+          .children(
+            arg[String]("query").action((x, c) => c.copy(query = x)).text("The query to be used."),
+            opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)"),
+            opt[Int]("limit").action((x, c) => c.copy(limit = Some(x))).text("The maximal number of results returned."),
+            opt[Unit](name = "list").action((_, c) => c.copy(list = true)).text("Output results as list (raw option overrides this)"),
+            opt[Int]("timeout").action((x, c) => c.copy(timeout = Some(x))).text("Timeout in seconds.")
+          )
       }
-
-    case None =>
+    }
+    parser
   }
 
+  def main(args: Array[String]): Unit = {
+
+    System.setProperty("java.library.path", javaLibPath.get)
+    System.setProperty("javax.net.ssl.trustStore", trustStorePath.get)
+    System.setProperty("picocli.ansi", "true")
+    cliParser.parse(args, config) match {
+      case Some(config) =>
+        if (!config.silent) cliParser.showHeader()
+        config.mode match {
+          case "test" => TestCommand.execute
+          //          case "retrieve" => RetrieveCommand.execute(config)
+          //        case "search" => SearchCommand.execute(config)
+          case x => config.consoleOutput.outputError(s"Unknown command: $x")
+        }
+      case None =>
+    }
 
-  val poolShutdown = Http().shutdownAllConnectionPools()
-  Await.result(poolShutdown, Duration.Inf)
-
-  implicit val ec: ExecutionContext = system.dispatcher
-  val terminationFuture = system.terminate()
-
-  terminationFuture.onComplete {
-    sys.exit(0)
   }
-}
+}

src/main/scala/de/upb/cs/swt/delphi/cli/commands/Command.scala

@@ -22,11 +22,12 @@ import akka.http.scaladsl.model.Uri.Query
 import akka.http.scaladsl.model.{HttpRequest, HttpResponse, StatusCodes, Uri}
 import akka.stream.ActorMaterializer
 import akka.util.ByteString
+import com.softwaremill.sttp._
 import de.upb.cs.swt.delphi.cli.Config
 
-import scala.concurrent.{Await, Future}
 import scala.concurrent.duration._
-import scala.util.{Failure, Success}
+import scala.concurrent.{Await, Future}
+import scala.util.Failure
 
 /**
   * Represents the implementation of a command of the CLI
@@ -35,17 +36,19 @@ trait Command {
 
   /**
     * Executes the command implementation
+    *
     * @param config The current configuration for the command
     */
-  def execute(config: Config)(implicit system : ActorSystem): Unit
+  def execute(implicit config: Config): Unit = {}
 
   /**
     * Implements a common request type using currying to avoid code duplication
+    *
     * @param target The endpoint to perform a Get request on
     * @param config The current configuration for the command
     */
-  protected def executeGet(target: String, parameters: Map[String, String] = Map())(config: Config, system : ActorSystem) : Option[String] = {
-    implicit val sys : ActorSystem = system
+  protected def executeGet(target: String, parameters: Map[String, String] = Map())(config: Config, system: ActorSystem): Option[String] = {
+    implicit val sys: ActorSystem = system
     implicit val materializer = ActorMaterializer()
     implicit val executionContext = sys.dispatcher
 
@@ -65,7 +68,7 @@ trait Command {
         entity.dataBytes.runFold(ByteString(""))(_ ++ _).map { body =>
           Some(body.utf8String)
         }
-      case resp @ HttpResponse(code, _, _, _) => {
+      case resp@HttpResponse(code, _, _, _) => {
         error(config)("Artifact not found.")
         resp.discardEntityBytes()
         Future(None)
@@ -75,9 +78,35 @@ trait Command {
     Await.result(resultString, Duration.Inf)
   }
 
+  /**
+    * Generic http GET request
+    *
+    * @param target Sub url in delphi server
+    * @param parameters Query params
+    * @return GET response
+    */
+  protected def executeGet1(target: String, parameters: Map[String, String] = Map())
+                           (implicit config: Config, backend: SttpBackend[Id, Nothing]): Option[String] = {
+
+    val request = sttp.get(uri"${config.server}/$target?$parameters")
+    config.consoleOutput.outputInformation(s"Sending request ${request.uri}")
+    val response = request.send()
+    response.body match {
+      case Left(value) =>
+        error.apply(s"Request failed:\n $value")
+        None
+      case Right(value) =>
+        Some(value)
+    }
+  }
+
+
   protected def information(implicit config: Config): String => Unit = config.consoleOutput.outputInformation _
+
   protected def reportResult(implicit config: Config): Any => Unit = config.consoleOutput.outputResult _
+
   protected def error(implicit config: Config): String => Unit = config.consoleOutput.outputError _
+
   protected def success(implicit config: Config): String => Unit = config.consoleOutput.outputSuccess _
 
   protected def exportResult(implicit config: Config): Any => Unit = config.csvOutput.exportResult _

src/main/scala/de/upb/cs/swt/delphi/cli/commands/RetrieveCommand.scala

@@ -38,7 +38,7 @@ import scala.util.{Failure, Success}
 object RetrieveCommand extends Command with SprayJsonSupport with DefaultJsonProtocol {
 
 
-  override def execute(config: Config)(implicit system: ActorSystem): Unit = {
+   def execute(config: Config)(implicit system: ActorSystem): Unit = {
     implicit val ec = system.dispatcher
     implicit val materializer = ActorMaterializer()
 

src/main/scala/de/upb/cs/swt/delphi/cli/commands/SearchCommand.scala

@@ -44,7 +44,7 @@ object SearchCommand extends Command with SprayJsonSupport with DefaultJsonProto
     *
     * @param config The current configuration for the command
     */
-  override def execute(config: Config)(implicit system: ActorSystem): Unit = {
+   def execute(config: Config)(implicit system: ActorSystem): Unit = {
     implicit val ec = system.dispatcher
     implicit val materializer = ActorMaterializer()
 

src/main/scala/de/upb/cs/swt/delphi/cli/commands/TestCommand.scala

@@ -16,17 +16,17 @@
 
 package de.upb.cs.swt.delphi.cli.commands
 
-import akka.actor.ActorSystem
 import de.upb.cs.swt.delphi.cli.Config
+import de.upb.cs.swt.delphi.cli._
 
 /**
   * The implementation of the test command.
   * Tries to connect to the Delphi server and reports on the results of the version call.
   */
 object TestCommand extends Command {
-  override def execute(config: Config)(implicit system : ActorSystem): Unit = executeGet(
-    "/version"
-  )(config, system).map(s => {
+  override def execute(implicit config: Config): Unit = executeGet1(
+    "version"
+  ).map(s => {
     success(config)("Successfully contacted Delphi server. ")
     information(config)("Server version: " + s)
   })

src/main/scala/de/upb/cs/swt/delphi/cli/package.scala

@@ -0,0 +1,30 @@
+// Copyright (C) 2018 The Delphi Team.
+// See the LICENCE file distributed with this work for additional
+// information regarding copyright ownership.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package de.upb.cs.swt.delphi
+
+import com.softwaremill.sttp.HttpURLConnectionBackend
+
+package object cli {
+  implicit val config: Config = Config()
+  implicit val backend = HttpURLConnectionBackend()
+
+  val javaLibPath = Option(System.getenv("JAVA_LIB_PATH"))
+    .orElse(Some("/usr/lib/jvm/default-java/lib/"))
+
+  val trustStorePath = Option(System.getenv("JAVA_TRUSTSTORE"))
+    .orElse(Some("/usr/lib/jvm/default-java/lib/security/cacerts"))
+
+}