Adding --csv option to search and retrieve (Issue #4 )

Author: sideresearch

build.sbt

@@ -27,6 +27,7 @@ libraryDependencies += "io.spray" %% "spray-json" % "1.3.3"
 libraryDependencies += "de.vandermeer" % "asciitable" % "0.3.2"
 libraryDependencies += "com.lihaoyi" %% "fansi" % "0.2.5"
 libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value
+libraryDependencies += "au.com.bytecode" % "opencsv" % "2.4"
 
 debianPackageDependencies := Seq("java8-runtime-headless")
 

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

@@ -26,6 +26,7 @@ package de.upb.cs.swt.delphi.cli
 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 = "",
                   silent: Boolean = false,
                   list : Boolean = false,
                   mode: String = "",
@@ -36,5 +37,6 @@ case class Config(server: String = sys.env.getOrElse("DELPHI_SERVER", "https://d
                   opts: List[String] = List()) {
 
   lazy val consoleOutput = new ConsoleOutput(this)
+  lazy val csvOutput = new CsvOutput(this)
 
 }

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

@@ -0,0 +1,69 @@
+// 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.cli
+
+import java.io.{BufferedWriter, FileWriter}
+
+import de.upb.cs.swt.delphi.cli.artifacts.Result
+import au.com.bytecode.opencsv.CSVWriter
+import de.upb.cs.swt.delphi.cli.commands.SearchCommand.information
+import de.vandermeer.asciitable.{AsciiTable, CWC_LongestLine}
+import de.vandermeer.skb.interfaces.transformers.textformat.TextAlignment
+
+import scala.collection.mutable.ListBuffer
+import scala.collection.JavaConverters._
+
+/**
+  * Export search and retrieve results to .csv file.
+  *
+  * @author Lisa Nguyen Quang Do
+  * @author Ben Hermann
+  *
+  */
+
+class CsvOutput(config: Config) {
+
+  def exportResult(value: Any): Unit = {
+    var table = value match {
+      case results : Seq[Result] if results.head.isInstanceOf[Result] => resultsToCsv(results)
+      case _ => {
+        println("Error: results are in unknown format.")
+        return
+      }
+    }
+
+    val outputFile = new BufferedWriter(new FileWriter(config.csv, /* append = */false))
+    val csvWriter = new CSVWriter(outputFile)
+    csvWriter.writeAll(seqAsJavaList(table))
+    outputFile.close()
+    println("Results written to file '" + config.csv + "'")
+  }
+
+  def resultsToCsv(results : Seq[Result]) : Seq[Array[String]] = {
+    if (results.size != 0) {
+      val fieldNames = results.head.fieldNames()
+      val tableHeader : Array[String] = (fieldNames.+:("discovered at").+:("version").+:("groupId").+:("artifactId").+:("source").+:("Id")).toArray
+      val tableBody: Seq[Array[String]] = results.map {
+        e => {
+          Array(e.id, e.metadata.source, e.metadata.artifactId, e.metadata.groupId, e.metadata.version, e.metadata.discovered).++(fieldNames.map(f => e.metricResults(f).toString))
+        }
+      }
+      return tableBody.+:(tableHeader)
+    }
+    return Seq.empty[Array[String]]
+  }
+}

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

@@ -35,7 +35,7 @@ object DelphiCLI extends App {
 
   val cliParser = {
     new scopt.OptionParser[Config]("delphi-cli") {
-      head("Delphi Command Line Tool", s"(${BuildInfo.version})")
+      head("Delphi Command Line Tool", s"(Lala)") // ${BuildInfo.version}
 
       version("version").text("Prints the version of the command line tool.")
 
@@ -55,15 +55,16 @@ object DelphiCLI extends App {
         .children(
           arg[String]("id").action((x, c) => c.copy(id = 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")
+            "with the filepath given in place of the ID"), opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)")
         )
 
       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[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[Unit](name="list").action((_, c) => c.copy(list = true)).text("Output results as list (raw option overrides this)"),
+          opt[String]("csv").action((x, c) => c.copy(csv = x)).text("Path to the output .csv file (overwrites existing file)")
         )
     }
   }

src/main/scala/de/upb/cs/swt/delphi/cli/artifacts/SearchResult.scala

@@ -18,21 +18,23 @@ package de.upb.cs.swt.delphi.cli.artifacts
 
 import spray.json.DefaultJsonProtocol
 
-case class RetrieveResult(val id: String,
-                          val metadata: ArtifactMetadata,
-                          val metricResults: Map[String, Int]) {
+trait Result{
+  val id: String
+  val metadata: ArtifactMetadata
+  val metricResults: Map[String, Int]
+
   def toMavenIdentifier() : String = s"${metadata.groupId}:${metadata.artifactId}:${metadata.version}"
 
   def fieldNames() : List[String] = metricResults.keys.toList.sorted
 }
 
-case class SearchResult(val id: String,
-                        val metadata: ArtifactMetadata,
-                        val metricResults: Map[String, Int]) {
-  def toMavenIdentifier() : String = s"${metadata.groupId}:${metadata.artifactId}:${metadata.version}"
+case class SearchResult(id: String,
+                        metadata: ArtifactMetadata,
+                        metricResults: Map[String, Int]) extends Result
 
-  def fieldNames() : List[String] = metricResults.keys.toList.sorted
-}
+case class RetrieveResult(id: String,
+                          metadata: ArtifactMetadata,
+                          metricResults: Map[String, Int]) extends Result
 
 case class ArtifactMetadata(val artifactId: String,
                             val source: String,

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

@@ -80,4 +80,6 @@ trait Command {
   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

@@ -23,6 +23,7 @@ import akka.stream.ActorMaterializer
 import de.upb.cs.swt.delphi.cli.Config
 import de.upb.cs.swt.delphi.cli.artifacts.RetrieveResult
 import de.upb.cs.swt.delphi.cli.artifacts.SearchResultJson._
+import de.upb.cs.swt.delphi.cli.commands.SearchCommand.information
 import spray.json.DefaultJsonProtocol
 
 import scala.concurrent.Await
@@ -62,7 +63,9 @@ object RetrieveCommand extends Command with SprayJsonSupport with DefaultJsonPro
     result.map(s => {
       if (config.raw) {
         reportResult(config)(s)
-      } else {
+      }
+
+      if (!config.raw || !config.csv.equals("")) {
         val unmarshalledFuture = Unmarshal(s).to[List[RetrieveResult]]
 
         unmarshalledFuture.transform {
@@ -71,6 +74,9 @@ object RetrieveCommand extends Command with SprayJsonSupport with DefaultJsonPro
             success(config)(s"Found ${unmarshalled.size} item(s).")
             reportResult(config)(unmarshalled)
 
+            if(!config.csv.equals(""))
+              exportResult(config)(unmarshalled)
+
             Success(unmarshalled)
           }
           case Failure(e) => {

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

@@ -77,7 +77,9 @@ object SearchCommand extends Command with SprayJsonSupport with DefaultJsonProto
 
     if (config.raw || result.equals("")) {
       reportResult(config)(result)
-    } else {
+    }
+
+    if(!(config.raw || result.equals("")) || !config.csv.equals("")) {
       val unmarshalledFuture = Unmarshal(result).to[List[SearchResult]]
 
       val processFuture = unmarshalledFuture.transform {
@@ -108,6 +110,9 @@ object SearchCommand extends Command with SprayJsonSupport with DefaultJsonProto
     reportResult(config)(results)
 
     information(config)(f"Query took $queryRuntime%.2fs.")
+
+    if(!config.csv.equals(""))
+      exportResult(config)(results)
   }
 
   case class Query(query: String,