ETCM-480 Add buildinfo endpoint (#860)

Author: enriquerodbe

build.sbt

@@ -2,6 +2,7 @@ enablePlugins(JDKPackagerPlugin, JavaAppPackaging, SolidityPlugin)
 
 import scala.sys.process.Process
 import NativePackagerHelper._
+import com.typesafe.sbt.SbtGit.GitKeys._
 
 // Necessary for the nix build, please do not remove.
 val nixBuild = sys.props.isDefinedAt("nix")
@@ -148,8 +149,20 @@ lazy val node = {
     .enablePlugins(BuildInfoPlugin)
     .dependsOn(bytes, crypto, rlp)
     .settings(
-      buildInfoKeys := Seq[BuildInfoKey](name, version, git.gitHeadCommit),
-      buildInfoPackage := "io.iohk.ethereum.utils"
+      buildInfoKeys := BuildInfoKey.ofN(
+        name,
+        version,
+        scalaVersion,
+        sbtVersion,
+        gitHeadCommit,
+        gitCurrentBranch,
+        gitCurrentTags,
+        gitDescribedVersion,
+        gitUncommittedChanges,
+        libraryDependencies in Compile
+      ),
+      buildInfoPackage := "io.iohk.ethereum.utils",
+      buildInfoOptions in Compile += BuildInfoOption.ToMap
     )
     .settings(commonSettings("mantis"): _*)
     .settings(

src/main/scala/io/iohk/ethereum/jsonrpc/server/http/JsonRpcHttpServer.scala

@@ -1,7 +1,6 @@
 package io.iohk.ethereum.jsonrpc.server.http
 
 import java.security.SecureRandom
-
 import akka.actor.ActorSystem
 import akka.http.scaladsl.model._
 import akka.http.scaladsl.server.Directives._
@@ -18,12 +17,12 @@ import io.iohk.ethereum.jsonrpc.serialization.JsonSerializers
 import io.iohk.ethereum.jsonrpc.server.controllers.JsonRpcBaseController
 import io.iohk.ethereum.jsonrpc.server.http.JsonRpcHttpServer.JsonRpcHttpServerConfig
 import io.iohk.ethereum.security.SSLError
-import io.iohk.ethereum.utils.{ConfigUtils, Logger}
+import io.iohk.ethereum.utils.{BuildInfo, ConfigUtils, Logger}
 import javax.net.ssl.SSLContext
 import monix.eval.Task
 import monix.execution.Scheduler.Implicits.global
+import org.json4s.native.Serialization
 import org.json4s.{DefaultFormats, JInt, native}
-
 import scala.concurrent.duration.{FiniteDuration, _}
 
 trait JsonRpcHttpServer extends Json4sSupport with RateLimit with Logger {
@@ -55,6 +54,8 @@ trait JsonRpcHttpServer extends Json4sSupport with RateLimit with Logger {
   val route: Route = cors(corsSettings) {
     (path("healthcheck") & pathEndOrSingleSlash & get) {
       handleHealthcheck()
+    } ~ (path("buildinfo") & pathEndOrSingleSlash & get) {
+      handleBuildInfo()
     } ~ (pathEndOrSingleSlash & post) {
       (extractClientIP & entity(as[JsonRpcRequest])) { (clientAddress, request) =>
         handleRequest(clientAddress, request)
@@ -106,8 +107,14 @@ trait JsonRpcHttpServer extends Json4sSupport with RateLimit with Logger {
     complete(httpResponseF.runToFuture)
   }
 
-  private def handleRequest(request: JsonRpcRequest) = {
-    complete(jsonRpcController.handleRequest(request).runToFuture)
+  private def handleBuildInfo(): StandardRoute = {
+    val buildInfo = Serialization.writePretty(BuildInfo.toMap)(DefaultFormats)
+    complete(
+      HttpResponse(
+        status = StatusCodes.OK,
+        entity = HttpEntity(ContentTypes.`application/json`, buildInfo)
+      )
+    )
   }
 
   private def handleBatchRequest(requests: Seq[JsonRpcRequest]) = {

src/test/scala/io/iohk/ethereum/jsonrpc/server/http/JsonRpcHttpServerSpec.scala

@@ -13,14 +13,16 @@ import ch.megard.akka.http.cors.scaladsl.model.HttpOriginMatcher
 import io.iohk.ethereum.jsonrpc.server.http.JsonRpcHttpServer.{JsonRpcHttpServerConfig, RateLimitConfig}
 import io.iohk.ethereum.jsonrpc.{JsonRpcController, JsonRpcHealthChecker, JsonRpcResponse}
 import monix.eval.Task
-import org.json4s.JsonAST.{JInt, JString}
+import org.json4s.JsonAST.{JInt, JNothing, JString}
 import org.scalamock.scalatest.MockFactory
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 import akka.http.scaladsl.model.headers._
 import io.iohk.ethereum.healthcheck.{HealthcheckResponse, HealthcheckResult}
-import io.iohk.ethereum.utils.Logger
+import io.iohk.ethereum.utils.{BuildInfo, Logger}
 import io.iohk.ethereum.jsonrpc.server.controllers.JsonRpcBaseController
+import org.json4s.{DefaultFormats, Extraction}
+import org.json4s.native.JsonMethods
 import scala.concurrent.duration.FiniteDuration
 
 class JsonRpcHttpServerSpec extends AnyFlatSpec with Matchers with ScalatestRouteTest {
@@ -45,6 +47,22 @@ class JsonRpcHttpServerSpec extends AnyFlatSpec with Matchers with ScalatestRout
     }
   }
 
+  it should "respond to buildinfo" in new TestSetup {
+    val buildInfoRequest = HttpRequest(HttpMethods.GET, uri = "/buildinfo")
+
+    buildInfoRequest ~> Route.seal(mockJsonRpcHttpServer.route) ~> check {
+      status shouldEqual StatusCodes.OK
+
+      val expected = Extraction.decompose(BuildInfo.toMap)(DefaultFormats)
+      val jsonResponse = JsonMethods.parse(responseAs[String])
+      val diff = expected.diff(jsonResponse)
+
+      diff.added shouldEqual JNothing
+      diff.changed shouldEqual JNothing
+      diff.deleted shouldEqual JNothing
+    }
+  }
+
   it should "pass valid json request to controller" in new TestSetup {
     (mockJsonRpcController.handleRequest _)
       .expects(*)

src/universal/conf/faucet.conf

@@ -144,4 +144,4 @@ mantis {
       apis = "faucet"
     }
   }
-}
+}