Merge pull request #146 from dwijnand/UpdateReport.toString

Make sure UpdateReport has a nice toString
sbt · Jul 28, 2017 · c6e8bd7 · c6e8bd7
2 parents 47e4dca + 5292385
commit c6e8bd7
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 1 deletion.
diff --git a/core/src/main/contraband-scala/sbt/librarymanagement/OrganizationArtifactReport.scala b/core/src/main/contraband-scala/sbt/librarymanagement/OrganizationArtifactReport.scala
@@ -30,7 +30,8 @@ final class OrganizationArtifactReport private (
     37 * (37 * (37 * (37 * (17 + "sbt.librarymanagement.OrganizationArtifactReport".##) + organization.##) + name.##) + modules.##)
   }
   override def toString: String = {
-    "OrganizationArtifactReport(" + organization + ", " + name + ", " + modules + ")"
+    val details = modules map { _.detailReport }
+    s"\t$organization:$name\n${details.mkString}\n"
   }
   protected[this] def copy(organization: String = organization, name: String = name, modules: Vector[sbt.librarymanagement.ModuleReport] = modules): OrganizationArtifactReport = {
     new OrganizationArtifactReport(organization, name, modules)

diff --git a/core/src/main/contraband/librarymanagement.json b/core/src/main/contraband/librarymanagement.json
@@ -596,6 +596,10 @@
         { "name": "organization", "type": "String"                              },
         { "name": "name",         "type": "String"                              },
         { "name": "modules",      "type": "sbt.librarymanagement.ModuleReport*" }
+      ],
+      "toString": [
+        "val details = modules map { _.detailReport }",
+        "s\"\\t$organization:$name\\n${details.mkString}\\n\""
       ]
     },
     {

diff --git a/core/src/test/scala/UpdateReportSpec.scala b/core/src/test/scala/UpdateReportSpec.scala
@@ -0,0 +1,41 @@
+package sbt.librarymanagement
+
+import java.io.File
+
+import org.scalatest._
+
+class UpdateReportSpec extends FlatSpec with Matchers {
+  "UpdateReport.toString" should "have a nice toString" in {
+    assert(updateReport.toString === s"""
+      |Update report:
+      |	Resolve time: 0 ms, Download time: 0 ms, Download size: 0 bytes
+      |	compile:
+      |	org:name
+      |		- 1.0
+      |			evicted: false
+      |
+      |""".stripMargin.drop(1))
+  }
+
+  lazy val updateReport =
+    UpdateReport(
+      new File("cachedDescriptor.data"),
+      Vector(configurationReport),
+      UpdateStats(0, 0, 0, false),
+      Map.empty
+    )
+
+  lazy val configurationReport =
+    ConfigurationReport(
+      ConfigRef("compile"),
+      Vector(moduleReport),
+      Vector(organizationArtifactReport)
+    )
+
+  lazy val moduleReport =
+    ModuleReport(ModuleID("org", "name", "1.0"), Vector.empty, Vector.empty)
+
+  lazy val organizationArtifactReport =
+    OrganizationArtifactReport("org", "name", Vector(moduleReport))
+
+}