Pending interactions in pact-jvm

[holomekc]

Hi,
I found this issue pact-foundation/pact-specification/issues/73 and I was wondering how I can set this in pact-jvm. I could find that the model contains the value:

pact-jvm/core/model/src/main/kotlin/au/com/dius/pact/core/model/V4Pact.kt

Line 139 in bb4010b

var pending: Boolean = false,

But I am not sure how I can set this in my consumer test. I searched in the @Pact annotation and also via the PactDslWithProvider, which we are using to define our expectations. But I could not find a way to do so.

What is the appropriate way to set this pending state?

Br,
Chris

PS: Is there a documentation regarding this value? I can only find the pending pacts docs, but nothing regarding pending interactions set by the consumer.

[rholshausen]

If you use the PactBuilder class, and one of the expectsToReceive methods (i.e. expectsToReceiveHttpInteraction), the child builders have a method to set the pending flag.

For example:

.expectsToReceiveHttpInteraction("V4 PactProviderTest test interaction", httpBuilder -> {
        return httpBuilder
          .withRequest(requestBuilder -> requestBuilder
            .path("/")
            .method("GET"))
          .willRespondWith(responseBuilder -> responseBuilder
            .status(200)
            .body("{\"responsetest\": true, \"version\": \"v3\"}")
            .header("test", notEmpty("Example"))
          )
          .pending(true); // <---
      })

[holomekc]

Thx for the incredible fast feedback. This works. Thank you so much.

[holomekc]

Hi
Sorry to reopen this again. The PactBuilder indicates that PactDslWithProvider and MessagePactBuilder are legacy, but the SynchronousMessagePactBuilder is not?

pact-jvm/consumer/src/main/kotlin/au/com/dius/pact/consumer/dsl/PactBuilder.kt

Lines 82 to 101 in a91598b

	/**
	* Use the old HTTP Pact DSL
	*/
	fun usingLegacyDsl(): PactDslWithProvider {
	return PactDslWithProvider(ConsumerPactBuilder(consumer), provider, pactVersion)
	}
	/**
	* Use the old Message Pact DSL
	*/
	fun usingLegacyMessageDsl(): MessagePactBuilder {
	return MessagePactBuilder(pactVersion).consumer(consumer).hasPactWith(provider)
	}
	/**
	* Use the Synchronous Message DSL
	*/
	fun usingSynchronousMessageDsl(): SynchronousMessagePactBuilder {
	return SynchronousMessagePactBuilder(pactVersion).consumer(consumer).hasPactWith(provider)
	}

But then how to achieve the same with Async? I can use the PactBuilder and set the pending flag, but then I am facing issues with creating the content of my expectations.

I could find:
/**

• Configure the interaction using a builder supplied by the plugin author.
  */
  fun with(builder: PluginInteractionBuilder): PactBuilder {
  require(currentInteraction != null) {
  "'with' must be preceded by 'expectsToReceive'"
  }
  return with(builder.build())
  }
  But there seems to be no provided PactInteractionBuilder for Async.

The other option is:

pact-jvm/consumer/src/main/kotlin/au/com/dius/pact/consumer/dsl/PactBuilder.kt

Lines 246 to 255 in a91598b

	/**
	* Values to configure the interaction. In the case of an interaction configured by a plugin, you need to follow
	* the plugin documentation of what values must be specified here.
	*/
	@Suppress("ComplexMethod")
	fun with(values: Map<String, Any?>): PactBuilder {
	require(currentInteraction != null) {
	"'with' must be preceded by 'expectsToReceive'"
	}

but then I would need to guess message.contents and write alle matching rules as text.

pact-jvm/consumer/src/main/kotlin/au/com/dius/pact/consumer/dsl/PactBuilder.kt

Lines 268 to 282 in a91598b

	is V4Interaction.AsynchronousMessage -> {
	logger.debug { "Configuring AsynchronousMessage interaction from $values" }
	if (values.containsKey("message.contents")) {
	val messageContents = setupMessageContents(this, values["message.contents"], interaction)
	if (messageContents.size > 1) {
	logger.warn { "Received multiple values for the interaction contents, will only use the first" }
	}
	val contents = messageContents.first()
	interaction.contents = contents.first
	if (contents.second.isNotEmpty()) {
	interaction.interactionMarkup = contents.second
	}
	}
	interaction.updateProperties(values.filter { it.key != "message.contents" })
	}

Is there a way to use a builder here and not just a map?

[rholshausen]

I've added the missing methods to SynchronousMessagePactBuilder.

You can also use PactBuilder.expectsToReceiveSynchronousMessageInteraction which works in the same way as the other interaction builders.