Merge branch 'develop' into Feature/4/scalastyle

Author: Hariharan Ramanathan

build.sbt

@@ -2,18 +2,33 @@ name := "delphi-cli"
 
 version := "1.0.0-SNAPSHOT"
 
+maintainer := "Ben Hermann <[email protected]>"
+
+packageSummary := "Windows Package for Delphi-cli"
+
+packageDescription := """Windows Package for Delphi-cli"""
+
+wixProductId := "ce07be71-510d-414a-92d4-dff47631848a"
+
+wixProductUpgradeId := "4552fb0e-e257-4dbd-9ecb-dba9dbacf424"
+
 scalaVersion := "2.12.4"
 
 libraryDependencies += "com.github.scopt" %% "scopt" % "3.7.0"
 libraryDependencies ++= Seq(
   "com.typesafe.akka" %% "akka-http-core" % "10.0.11"
 )
 
+debianPackageDependencies := Seq("java8-runtime-headless")
+
 lazy val cli = (project in file(".")).
   enablePlugins(JavaAppPackaging).
   enablePlugins(DockerPlugin).
   enablePlugins(ScalastylePlugin).
   enablePlugins(BuildInfoPlugin).
+  enablePlugins(DebianPlugin).
+  enablePlugins(WindowsPlugin).
+
   settings(
     buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
     buildInfoPackage := "de.upb.cs.swt.delphi.cli"

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

@@ -6,6 +6,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/"), verbose: Boolean = false, mode : String = "") {
+case class Config (server : String = sys.env.getOrElse("DELPHI_SERVER", "https://delphi.cs.uni-paderborn.de/api/"),
+                   verbose: Boolean = false, mode : String = "", args : List[String] = List(), opts : List[String] = List()) {
 
 }

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

@@ -1,5 +1,7 @@
 package de.upb.cs.swt.delphi.cli
 
+import de.upb.cs.swt.delphi.cli.commands.{RetrieveCommand, TestCommand}
+
 
 /**
   * The application class for the Delphi command line interface
@@ -20,8 +22,16 @@ object DelphiCLI extends App {
       checkConfig(c => if (c.server.isEmpty()) failure("Option server is required.") else success)
 
       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(args = List(x))).text("The ID of the project to retrieve"),
+          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")
-      //cmd("retrieve")
     }
   }
 
@@ -31,6 +41,7 @@ object DelphiCLI extends App {
       cliParser.showHeader()
       config.mode match {
         case "test" => TestCommand.execute(config)
+        case "retrieve" => RetrieveCommand.execute(config)
         case _ => println("Unknown command")
       }
 

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

@@ -0,0 +1,38 @@
+package de.upb.cs.swt.delphi.cli.commands
+
+import akka.http.scaladsl.model.Uri
+import de.upb.cs.swt.delphi.cli.{BlockingHttpClient, Config}
+
+import scala.util.{Failure, Success}
+
+/**
+  * Represents the implementation of a command of the CLI
+  */
+trait Command {
+
+  /**
+    * Executes the command implementation
+    * @param config The current configuration for the command
+    */
+  def execute(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 onSuccess The function to perform on the response (eg. printing it)
+    * @param config The current configuration for the command
+    */
+  protected def executeGet(target: String, onSuccess: String => Unit)(config: Config) : Unit = {
+
+    val uri = Uri(config.server)
+    println(s"Contacting server ${uri}...")
+    val resp = BlockingHttpClient.doGet(uri.withPath(uri.path + target))
+
+    resp match {
+      case Success(res) => onSuccess(res)
+      case Failure(_) => println(s"Could not reach server ${config.server}.")
+    }
+
+  }
+
+}

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

@@ -0,0 +1,27 @@
+package de.upb.cs.swt.delphi.cli.commands
+
+import de.upb.cs.swt.delphi.cli.Config
+import io.Source
+
+/**
+  * The implementation of the retrieve command.
+  * Retrieves the contents of the file at the endpoint specified by the config file, and prints them to stdout
+  */
+object RetrieveCommand extends Command {
+  override def execute(config: Config): Unit = {
+    //Checks whether the ID should be loaded from a file or not, and either returns the first line
+    //  of the given file if it is, or the specified ID otherwise
+    def checkTarget: String = {
+      if (config.opts.contains("file")) {
+        val source = Source.fromFile(config.args.head)
+        val target = source.getLines.next()
+        source.close()
+        target
+      } else config.args.head
+    }
+    executeGet(
+      "/retrieve/" + checkTarget,
+      s => println(s)
+    )(config)
+  }
+}

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

@@ -0,0 +1,17 @@
+package de.upb.cs.swt.delphi.cli.commands
+
+import de.upb.cs.swt.delphi.cli.Config
+
+/**
+  * 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): Unit = executeGet(
+    "/version",
+    s => {
+      println("Successfully contacted Delphi server. ")
+      println("Server version: " + s)
+    }
+  )(config)
+}