Search code examples
jsonscalascalatestmatcher

Any scalatest matchers for matching json

My test currently expects to match the converted json string from a method under test. I have constructed an expected string to perform the match.

val input = Foobar("bar", "foo")
val body = Foobar("bar !!", "foo!!")
val responseHeaders = Map[String, String]("Content-Type" -> "application/json")
val statusCode = "200"
val responseEvent = ResponseEvent(input, body, responseHeaders, statusCode)

val expected ="{\"input\":{\"foo\":\"bar\",\"bar\":\"foo\"},\"body\":{\"foo\":\"bar !!\",\"bar\":\"foo!!\"},\"headers\":{\"Content-Type\":\"application/json\"},\"statusCode\":\"200\"}"

val result = Main.stringifyResponse(responseEvent)

result should be(expected)

The string matching is extremely sensitive and fails on any whitespace, also any string written on multiline is not accepted for the test because the result is only available on one line as a result of stringifying using json4s library.

Is there a better way to perform matching on json output without having to do a full blown string comparision using scalatest.

Is there a better approach to create this test?

Solution

  • You have two options!

    1. Use a library like Play Json with which you could box your raw Json String into a JsObject and do the check using Scalatest. If you already use a JSON library, see if you can leverage that!

    2. Box your JSON into a case class and check for equality!