Content verifiers

Default content verification is based on contentType attribute:

This mapping may be configured by additionalContentTypeConfigs parameter of WsPlugin constructor:

public class Specs extends AbstractSpecs {
    @Override
    protected ExamExtension init() {
        return new ExamExtension(
            new WsPlugin(
                8080,
                Map.of(
                    ContentType.JSON,
                    new ContentTypeConfig(new JsonResolver(), new JsonVerifier(), new JsonPrinter())
                )
            )
        );
    }
    ...
}

To override content verifier for specific case case.expected.verifyAs attribute may be used.

Built-in implementations :

This list may be augmented by ExamExtension.withContentVerifiers method:

public class Specs extends AbstractSpecs {
    @Override
    protected ExamExtension init() {
        return new ExamExtension(
            ...
        ).withContentVerifiers(
            Map.of("customFormat", new ContentVerifier.Default())
        );
    }
}

Examples

.withContentTypeConfigs(
    mapOf(
        "jsonIgnoreExtraFields" to JsonContentTypeConfig(
            verifier = JsonVerifier { it.withOptions(IGNORING_EXTRA_FIELDS) }
        ),
        "jsonIgnorePaths" to JsonContentTypeConfig(
            verifier = JsonVerifier { it.whenIgnoringPaths("param2", "arr[*].param4") }
        ),
    )
)

<e:get url="ignoreJson">
  <e:case desc="verify using jsonIgnoreExtraFields">
    <e:expected verifyAs="jsonIgnoreExtraFields"> { "param1":"value1", "arr":[ {"param3":"value3"}, {"param3":"value3"} ] } </e:expected>
  </e:case>
  <e:case desc="verify using jsonIgnorePaths">
    <e:expected verifyAs="jsonIgnorePaths"> { "param1":"value1", "arr":[ {"param3":"value3"}, {"param3":"value3"} ] } </e:expected>
  </e:case>
</e:get>

GET ignoreJson HTTP/1.1

{
  "param1": "value1",
  "arr": [{
    "param3": "value3"
  }, {
    "param3": "value3"
  }]
}

{
  "param1": "value1",
  "param2": "value2",
  "arr": [{
    "param3": "value3",
    "param4": "value4"
  }, {
    "param3": "value3",
    "param4": "value4"
  }]
}

GET ignoreJson HTTP/1.1

{
  "param1": "value1",
  "arr": [{
    "param3": "value3"
  }, {
    "param3": "value3"
  }]
}

{
  "param1": "value1",
  "param2": "value2",
  "arr": [{
    "param3": "value3",
    "param4": "value4"
  }, {
    "param3": "value3",
    "param4": "value4"
  }]
}