chore: implemented can-i-deploy call on the broker client #994

Author: Ronald Holshausen

core/pact-broker/src/main/kotlin/au/com/dius/pact/core/pactbroker/HalClient.kt

@@ -140,6 +140,9 @@ interface IHalClient {
    * Upload a JSON document to the current path link, using a PUT request
    */
   fun putJson(link: String, options: Map<String, Any>, json: String): Result<Boolean, Exception>
+
+  fun getJson(path: String): Result<JsonElement, Exception>
+  fun getJson(path: String, encodePath: Boolean): Result<JsonElement, Exception>
 }
 
 /**
@@ -260,7 +263,9 @@ open class HalClient @JvmOverloads constructor(
     return this
   }
 
-  private fun getJson(path: String, encodePath: Boolean = true): Result<JsonElement, Exception> {
+  override fun getJson(path: String) = getJson(path, true)
+
+  override fun getJson(path: String, encodePath: Boolean): Result<JsonElement, Exception> {
     setupHttpClient()
     return Result.of {
       val httpGet = initialiseRequest(HttpGet(buildUrl(baseUrl, path, encodePath)))

core/pact-broker/src/main/kotlin/au/com/dius/pact/core/pactbroker/PactBrokerClient.kt

@@ -3,6 +3,7 @@ package au.com.dius.pact.core.pactbroker
 import au.com.dius.pact.com.github.michaelbull.result.Err
 import au.com.dius.pact.com.github.michaelbull.result.Ok
 import au.com.dius.pact.com.github.michaelbull.result.Result
+import au.com.dius.pact.core.support.Json
 import com.github.salomonbrys.kotson.get
 import com.github.salomonbrys.kotson.jsonArray
 import com.github.salomonbrys.kotson.jsonObject
@@ -124,7 +125,7 @@ open class PactBrokerClient(val pactBrokerUrl: String, val options: Map<String,
   @JvmOverloads
   open fun uploadPactFile(pactFile: File, unescapedVersion: String, tags: List<String> = emptyList()): Any? {
     val pactText = pactFile.readText()
-    val pact = JsonParser().parse(pactText)
+    val pact = JsonParser.parseString(pactText)
     val halClient = newHalClient()
     val providerName = urlPathSegmentEscaper().escape(pact["provider"]["name"].string)
     val consumerName = urlPathSegmentEscaper().escape(pact["consumer"]["name"].string)
@@ -228,8 +229,8 @@ open class PactBrokerClient(val pactBrokerUrl: String, val options: Map<String,
                 "metadata" -> {
                   listOf(jsonObject(mismatch.filter { it.key != "interactionId" }
                     .flatMap {
-                      when {
-                        it.key == "type" -> listOf("attribute" to it.value)
+                      when (it.key) {
+                        "type" -> listOf("attribute" to it.value)
                         else -> listOf("identifier" to it.key, "description" to it.value)
                       }
                     }))
@@ -302,7 +303,36 @@ open class PactBrokerClient(val pactBrokerUrl: String, val options: Map<String,
   }
 
   open fun canIDeploy(pacticipant: String, pacticipantVersion: String, latest: Latest, to: String?): CanIDeployResult {
-    return CanIDeployResult(false, "", "")
+    val halClient = newHalClient()
+    val result = halClient.getJson("/matrix" + buildMatrixQuery(pacticipant, pacticipantVersion, latest, to),
+      false)
+    return when (result) {
+      is Ok -> {
+        val summary = result.value.asJsonObject["summary"].asJsonObject
+        CanIDeployResult(Json.toBoolean(summary["deployable"]), "", Json.toString(summary["reason"]))
+      }
+      is Err -> {
+        logger.error(result.error) { "Pact broker matrix query failed: ${result.error.message}" }
+        CanIDeployResult(false, result.error.message.toString(), "")
+      }
+    }
+  }
+
+  private fun buildMatrixQuery(pacticipant: String, pacticipantVersion: String, latest: Latest, to: String?): String {
+    val escaper = urlPathSegmentEscaper()
+    var base = "?q[][pacticipant]=${escaper.escape(pacticipant)}"
+    base += when (latest) {
+      is Latest.UseLatest -> if (latest.latest) {
+        "q[][latest]=true"
+      } else {
+        "&q[][version]=${escaper.escape(pacticipantVersion)}"
+      }
+      is Latest.UseLatestTag -> "q[][tag]=${escaper.escape(latest.latestTag)}"
+    }
+    if (!to.isNullOrEmpty()) {
+      base += "&latest=true&tag=${escaper.escape(to)}"
+    }
+    return base
   }
 
   companion object : KLogging() {

core/support/src/main/kotlin/au/com/dius/pact/core/support/Json.kt

@@ -111,4 +111,10 @@ object Json {
 
   fun exceptionToJson(exp: Exception) = jsonObject("message" to exp.message,
     "exceptionClass" to exp.javaClass.name)
+
+  fun toBoolean(jsonElement: JsonElement?) = when {
+    jsonElement == null || jsonElement.isJsonNull -> false
+    jsonElement.isJsonPrimitive && jsonElement.asJsonPrimitive.isBoolean -> jsonElement.asJsonPrimitive.asBoolean
+    else -> false
+  }
 }

core/support/src/test/groovy/au/com/dius/pact/core/support/JsonSpec.groovy

@@ -1,5 +1,6 @@
 package au.com.dius.pact.core.support
 
+import com.google.gson.JsonParser
 import spock.lang.Specification
 import spock.lang.Unroll
 
@@ -22,4 +23,23 @@ class JsonSpec extends Specification {
     'object'  | [hello: 'world', list: [1, 2, 3]] | '{"hello":"world","list":[1,2,3]}'
   }
 
+  @Unroll
+  def 'toBoolean - #desc'() {
+    expect:
+    Json.INSTANCE.toBoolean(json == null ? json : JsonParser.parseString(json)) == booleanValue
+
+    where:
+
+    desc            | json                                    | booleanValue
+    'Null'          | null                                    | false
+    'Json Null'     | 'null'                                  | false
+    'Boolean True'  | 'true'                                  | true
+    'Boolean False' | 'false'                                 | false
+    'integer'       | '112'                                   | false
+    'float'         | '112.66'                                | false
+    'string'        | '"hello"'                               | false
+    'list'          | '["hello", 1, true, {"a": "A"}]'        | false
+    'object'        | '{"hello": "world", "list": [1, 2, 3]}' | false
+  }
+
 }