au.com.dius.pact.provider.junitsupport.loader

Class SelectorBuilder

au.com.dius.pact.provider.junitsupport.loader.SelectorBuilder

public class SelectorBuilder

Builder for setting up consumer version selectors in provider JUnit tests. See https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors

Constructor Detail

SelectorBuilder

public SelectorBuilder()

Builder for setting up consumer version selectors in provider JUnit tests. See https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors

Method Detail

getSelectors

@NotNull
public java.util.List<au.com.dius.pact.core.pactbroker.ConsumerVersionSelectors> getSelectors()

mainBranch

@NotNull
public SelectorBuilder mainBranch()

The latest version from the main branch of each consumer, as specified by the consumer's mainBranch property.

branch

@JvmOverloads
 @NotNull
public SelectorBuilder branch(@NotNull
                                                      java.lang.String name,
                                                      @Nullable
                                                      java.lang.String consumer,
                                                      @Nullable
                                                      java.lang.String fallback)

The latest version from a particular branch of each consumer, or for a particular consumer if the second parameter is provided. If fallback is provided, falling back to the fallback branch if none is found from the specified branch.

Parameters:

name -

• Branch name

consumer -

• Consumer name (optional)

fallback -

• Fall back to this branch if none is found from the specified branch (optional)

branch

@JvmOverloads
 @NotNull
public SelectorBuilder branch(@NotNull
                                                      java.lang.String name,
                                                      @Nullable
                                                      java.lang.String consumer)

The latest version from a particular branch of each consumer, or for a particular consumer if the second parameter is provided. If fallback is provided, falling back to the fallback branch if none is found from the specified branch.

Parameters:

name -

• Branch name

consumer -

• Consumer name (optional)

branch

@JvmOverloads
 @NotNull
public SelectorBuilder branch(@NotNull
                                                      java.lang.String name)

The latest version from a particular branch of each consumer, or for a particular consumer if the second parameter is provided. If fallback is provided, falling back to the fallback branch if none is found from the specified branch.

Parameters:

name -

• Branch name

deployedOrReleased

@NotNull
public SelectorBuilder deployedOrReleased()

All the currently deployed and currently released and supported versions of each consumer.

matchingBranch

@NotNull
public SelectorBuilder matchingBranch()

The latest version from any branch of the consumer that has the same name as the current branch of the provider. Used for coordinated development between consumer and provider teams using matching feature branch names.

deployedTo

@NotNull
public SelectorBuilder deployedTo(@NotNull
                                           java.lang.String environment)

Any versions currently deployed to the specified environment

releasedTo

@NotNull
public SelectorBuilder releasedTo(@NotNull
                                           java.lang.String environment)

Any versions currently released and supported in the specified environment

environment

@NotNull
public SelectorBuilder environment(@NotNull
                                            java.lang.String environment)

any versions currently deployed or released and supported in the specified environment

tag

@NotNull
public SelectorBuilder tag(@NotNull
                                    java.lang.String name)

All versions with the specified tag

latestTag

@NotNull
public SelectorBuilder latestTag(@NotNull
                                          java.lang.String name)

The latest version for each consumer with the specified tag

selector

@Deprecated
 @NotNull
public SelectorBuilder selector(@Nullable
                                                      java.lang.String tagName,
                                                      @Nullable
                                                      java.lang.Boolean latest,
                                                      @Nullable
                                                      java.lang.String fallbackTag,
                                                      @Nullable
                                                      java.lang.String consumer)

Deprecated.

Generic selector.

• With just the tag name, returns all versions with the specified tag.

• With latest, returns the latest version for each consumer with the specified tag.

• With a fallback tag, returns the latest version for each consumer with the specified tag, falling back to the fallbackTag if non is found with the specified tag.

• With a consumer name, returns the latest version for a specified consumer with the specified tag.

• With only latest, returns the latest version for each consumer. NOT RECOMMENDED as it suffers from race conditions when pacts are published from multiple branches.

rawSelectorJson

@NotNull
public SelectorBuilder rawSelectorJson(@NotNull
                                                java.lang.String json)

Selector in raw JSON form.

build

@NotNull
public java.util.List<au.com.dius.pact.core.pactbroker.ConsumerVersionSelectors> build()

Construct the final list of consumer version selectors