Implement new pact-broker "pacts-for-verification" feature (#178)

* new pact source type

* break up logic in Verifier

* add example showing pacts-for-verification working

* update test-examples script

Author: jbwheatley

example/consumer/build.sbt

@@ -14,6 +14,7 @@ lazy val pactVersionFile: SettingKey[File] = settingKey[File]("location of scala
 pactVersionFile := baseDirectory.value.getParentFile.getParentFile / "version.sbt"
 
 libraryDependencies ++= {
+    //A hack so we don't have to manually update the scala-pact version for the examples
     lazy val pactVersion = IO.read(pactVersionFile.value).split('"')(1)
     Seq(
         "com.itv" %% "scalapact-circe-0-13" % pactVersion % "test",

example/consumer/pact.sbt

@@ -0,0 +1,6 @@
+//For publishing to pact-broker test server (these credentials are public knowledge)
+
+pactBrokerAddress := "https://test.pact.dius.com.au"
+pactBrokerCredentials := ("dXfltyFMgNOFZAxr8io9wJ37iUpY42M", "O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1")
+pactContractVersion := "0.2.0"
+pactContractTags := Seq("example")

example/consumer/project/plugins.sbt

@@ -2,6 +2,12 @@ import java.io.File
 
 import sbt.Defaults.sbtPluginExtra
 
+/*
+This is just so we don't need to set the version manually for the examples. In reality you should just do
+
+addSbtPlugin("com.itv" % "sbt-scalapact" % scalaPactVersion)
+*/
+
 lazy val pactVersionFile: SettingKey[File] = settingKey[File]("location of scala-pact version for examples")
 pactVersionFile := baseDirectory.value.getParentFile.getParentFile.getParentFile / "version.sbt"
 

example/consumer/src/test/scala/com/example/consumer/ProviderClientSpec.scala

@@ -18,6 +18,9 @@ class ProviderClientSpec extends FunSpec with Matchers {
 
   implicit val formats = DefaultFormats
 
+  val CONSUMER = "scala-pact-consumer"
+  val PROVIDER = "scala-pact-provider"
+
   describe("Connecting to the Provider service") {
 
     it("should be able to fetch results") {
@@ -32,8 +35,8 @@ class ProviderClientSpec extends FunSpec with Matchers {
       )
 
       forgePact
-        .between("Consumer")
-        .and("Provider")
+        .between(CONSUMER)
+        .and(PROVIDER)
         .addInteraction(
           interaction
             .description("Fetching results")
@@ -54,8 +57,8 @@ class ProviderClientSpec extends FunSpec with Matchers {
 
     it("should be able to get an auth token") {
       forgePact
-        .between("Consumer")
-        .and("Provider")
+        .between(CONSUMER)
+        .and(PROVIDER)
         .addInteraction(
           interaction
             .description("Fetching least secure auth token ever")

example/deliver.sh

@@ -2,7 +2,7 @@
 
 echo "Attempting to deliver pact file"
 
-PACT_NAME="Consumer_Provider.json"
+PACT_NAME="scala-pact-consumer_scala-pact-provider.json"
 PACT_FILE="consumer/target/pacts/$PACT_NAME"
 
 if [ ! -f $PACT_FILE ]

example/provider/delivered_pacts/Consumer_Provider.json renamed to example/provider/delivered_pacts/scala-pact-consumer_scala-pact-provider.json

@@ -1,24 +1,27 @@
 {
   "provider" : {
-    "name" : "Provider"
+    "name" : "scala-pact-provider"
+  },
+  "consumer" : {
+    "name" : "scala-pact-consumer"
   },
   "interactions" : [
     {
+      "description" : "Fetching least secure auth token ever",
       "request" : {
         "method" : "GET",
         "path" : "/auth_token",
+        "headers" : {
+          "Accept" : "application/json",
+          "Name" : "Bob"
+        },
         "matchingRules" : {
           "$.headers.Name" : {
             "match" : "regex",
             "regex" : "^([a-zA-Z]+)$"
           }
-        },
-        "headers" : {
-          "Accept" : "application/json",
-          "Name" : "Bob"
         }
       },
-      "description" : "Fetching least secure auth token ever",
       "response" : {
         "status" : 202,
         "headers" : {
@@ -36,11 +39,12 @@
       }
     },
     {
+      "providerState" : "Results: Bob, Fred, Harry",
+      "description" : "Fetching results",
       "request" : {
         "method" : "GET",
         "path" : "/results"
       },
-      "description" : "Fetching results",
       "response" : {
         "status" : 200,
         "headers" : {
@@ -54,13 +58,9 @@
             "Harry"
           ]
         }
-      },
-      "providerState" : "Results: Bob, Fred, Harry"
+      }
     }
   ],
-  "consumer" : {
-    "name" : "Consumer"
-  },
   "metadata" : {
     "pactSpecification" : {
       "version" : "2.0.0"

example/provider_pact-for-verification/.scalafmt.conf

@@ -0,0 +1,4 @@
+style = defaultWithAlign
+maxColumn = 120
+rewrite.rules = [RedundantBraces,RedundantParens,PreferCurlyFors]
+danglingParentheses = true

example/provider_pact-for-verification/build.sbt

@@ -0,0 +1,30 @@
+import java.io.File
+
+organization := "com.example"
+
+name := "provider_pacts-for-verification"
+
+
+scalaVersion := "2.13.3"
+
+lazy val pactVersionFile: SettingKey[File] = settingKey[File]("location of scala-pact version for examples")
+pactVersionFile := baseDirectory.value.getParentFile.getParentFile / "version.sbt"
+
+libraryDependencies ++= {
+    //A hack so we don't have to manually update the scala-pact version for the examples
+    lazy val pactVersion = IO.read(pactVersionFile.value).split('"')(1)
+    Seq(
+    "org.http4s"    %% "http4s-blaze-server"   % "0.21.7",
+    "org.http4s"    %% "http4s-dsl"            % "0.21.7",
+    "org.http4s"    %% "http4s-circe"          % "0.21.7",
+    "org.slf4j"     % "slf4j-simple"           % "1.6.4",
+    "org.scalatest" %% "scalatest"             % "3.0.8" % "test",
+    "com.itv"       %% "scalapact-circe-0-13"  % pactVersion % "test",
+    "com.itv"       %% "scalapact-http4s-0-21" % pactVersion % "test",
+    "com.itv"       %% "scalapact-scalatest"   % pactVersion % "test",
+    // Optional for auto-derivation of JSON codecs
+    "io.circe" %% "circe-generic" % "0.13.0",
+    // Optional for string interpolation to JSON model
+    "io.circe" %% "circe-literal" % "0.13.0",
+  )
+}

example/provider_pact-for-verification/people.txt

@@ -0,0 +1 @@
+Bob,Fred,Harry

example/provider_pact-for-verification/project/build.properties

@@ -0,0 +1 @@
+sbt.version = 1.3.2

example/provider_pact-for-verification/project/plugins.sbt

@@ -0,0 +1,13 @@
+import java.io.File
+
+import sbt.Defaults.sbtPluginExtra
+
+lazy val pactVersionFile: SettingKey[File] = settingKey[File]("location of scala-pact version for examples")
+pactVersionFile := baseDirectory.value.getParentFile.getParentFile.getParentFile / "version.sbt"
+
+libraryDependencies += {
+  val pactVersion = IO.read(pactVersionFile.value).split('"')(1)
+  val sbtV = (sbtBinaryVersion in pluginCrossBuild).value
+  val scalaV = (scalaBinaryVersion in update).value
+  sbtPluginExtra("com.itv" % "sbt-scalapact" % pactVersion, sbtV, scalaV)
+}

example/provider_pact-for-verification/src/main/scala/com/example/provider/BusinessLogic.scala

@@ -0,0 +1,25 @@
+package com.example.provider
+
+import java.io.File
+import scala.io.Source
+import scala.util.Random
+
+object BusinessLogic {
+
+  def loadPeople(peopleFile: String): List[String] = {
+    val source = Source.fromFile(new File(peopleFile).toURI)
+    val people = source
+      .getLines
+      .mkString
+      .split(',')
+      .toList
+
+    source.close()
+
+    people
+  }
+
+  def generateToken(requiredLength: Int): String =
+    Random.alphanumeric.take(requiredLength).mkString
+
+}

example/provider_pact-for-verification/src/main/scala/com/example/provider/Provider.scala

@@ -0,0 +1,45 @@
+package com.example.provider
+
+import cats.effect._
+import io.circe.generic.auto._
+import io.circe.syntax._
+import org.http4s._
+import org.http4s.circe._
+import org.http4s.dsl.io._
+import org.http4s.util.CaseInsensitiveString
+import org.http4s.implicits._
+
+object Provider {
+
+  val service: (String => List[String]) => (Int => String) => HttpApp[IO] = loadPeopleData =>
+    genToken =>
+      HttpRoutes.of[IO] {
+        case request @ GET -> Root / "results" =>
+          val pactHeader = request.headers.get(CaseInsensitiveString("Pact")).map(_.value).getOrElse("")
+
+          Ok(ResultResponse(3, loadPeopleData("people.txt")).asJson).map(_.putHeaders(Header("Pact", pactHeader)))
+
+        case request @ GET -> Root / "auth_token" =>
+          val acceptHeader = request.headers.get(CaseInsensitiveString("Accept")).map(_.value)
+          val nameHeader   = request.headers.get(CaseInsensitiveString("Name")).map(_.value)
+
+          (acceptHeader, nameHeader) match {
+            case (Some(_), Some(_)) =>
+              val token = genToken(10)
+              Accepted(Token(token).asJson).map(_.withHeaders(Headers.of(Header("Content-Type", "application/json; charset=UTF-8"))))
+
+            case (Some(_), None) =>
+              BadRequest("Missing name header")
+
+            case (None, Some(_)) =>
+              BadRequest("Missing accept header")
+
+            case (None, None) =>
+              BadRequest("Missing accept and name headers")
+          }
+  }.orNotFound
+
+}
+
+case class ResultResponse(count: Int, results: List[String])
+case class Token(token: String)

example/provider_pact-for-verification/src/main/scala/com/example/provider/Server.scala

@@ -0,0 +1,28 @@
+package com.example.provider
+
+import java.util.concurrent.Executors
+
+import cats.effect.IO
+import cats.effect._
+import org.http4s.server.blaze.BlazeServerBuilder
+import org.http4s.server._
+
+import scala.concurrent.ExecutionContext
+
+object AlternateStartupApproach extends IOApp {
+  val executionContext = ExecutionContext.fromExecutor(
+    Executors.newFixedThreadPool(Runtime.getRuntime.availableProcessors())
+  )
+
+  // On ordinary start up, this service will begin here.
+  def run(args: List[String]): IO[ExitCode] =
+    serverResource(BusinessLogic.loadPeople, BusinessLogic.generateToken)
+      .use(_ => IO.never).as(ExitCode.Success)
+
+  def serverResource(loadPeopleData: String => List[String], genToken: Int => String): Resource[IO, Server[IO]] =
+    BlazeServerBuilder[IO](executionContext)
+      .bindHttp(8080)
+      .withHttpApp(Provider.service(loadPeopleData)(genToken))
+      .resource
+
+}

example/provider_pact-for-verification/src/test/scala/com/example/provider/VerifyContractsSpec.scala

@@ -0,0 +1,51 @@
+package com.example.provider
+
+import org.scalatest.{BeforeAndAfterAll, FunSpec, Matchers}
+import com.itv.scalapact.ScalaPactVerify._
+import com.itv.scalapact.shared.{ConsumerVersionSelector, PactBrokerAuthorization, ProviderStateResult}
+
+import scala.concurrent.duration._
+
+class VerifyContractsSpec extends FunSpec with Matchers with BeforeAndAfterAll {
+
+  import com.itv.scalapact.circe13._
+  import com.itv.scalapact.http4s21._
+
+  val serverAllocated =
+    AlternateStartupApproach.serverResource(_ => List("Bob", "Fred", "Harry"), _ => "abcABC123").allocated.unsafeRunSync()
+
+  override def beforeAll(): Unit = {
+    ()
+  }
+
+  override def afterAll(): Unit = {
+    serverAllocated._2.unsafeRunSync()
+  }
+
+
+  describe("Verifying Consumer Contracts") {
+    it("should be able to verify it's contracts") {
+      val consumer = ConsumerVersionSelector("example", latest = true) // This should fetch all the latest pacts of consumer with tag example
+
+      verifyPact
+        .withPactSource(
+          pactBrokerWithVersionSelectors(
+            "https://test.pact.dius.com.au",
+            "scala-pact-provider",
+            List(consumer),
+            List(),
+            None,
+            //again, these are publicly known creds for a test pact-broker
+            PactBrokerAuthorization(pactBrokerCredentials = ("dXfltyFMgNOFZAxr8io9wJ37iUpY42M", "O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1"), "")
+          )
+        )
+        .setupProviderState("given") {
+          case "Results: Bob, Fred, Harry" =>
+            val newHeader = "Pact" -> "modifiedRequest"
+            ProviderStateResult(true, req => req.copy(headers = Option(req.headers.fold(Map(newHeader))(_ + newHeader))))
+        }
+        .runVerificationAgainst("localhost", 8080, 10.seconds)
+    }
+  }
+
+}

example/provider_tests/build.sbt

@@ -11,6 +11,7 @@ lazy val pactVersionFile: SettingKey[File] = settingKey[File]("location of scala
 pactVersionFile := baseDirectory.value.getParentFile.getParentFile / "version.sbt"
 
 libraryDependencies ++= {
+    //A hack so we don't have to manually update the scala-pact version for the examples
     lazy val pactVersion = IO.read(pactVersionFile.value).split('"')(1)
     Seq(
     "org.http4s"    %% "http4s-blaze-server"   % "0.21.7",