Struct pact_models::v4::pact::V4Pact

pub struct V4Pact {
    pub consumer: Consumer,
    pub provider: Provider,
    pub interactions: Vec<Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>>,
    pub metadata: BTreeMap<String, Value>,
    pub plugin_data: Vec<PluginData>,
}

V4 spec Struct that represents a pact between the consumer and provider of a service.

Fields

consumer: Consumer

Consumer side of the pact

provider: Provider

Provider side of the pact

interactions: Vec<Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>>

List of messages between the consumer and provider.

metadata: BTreeMap<String, Value>

Metadata associated with this pact.

plugin_data: Vec<PluginData>

Plugin data associated with this pact

Implementations

impl V4Pact

pub fn has_interactions(&self, interaction_type: V4InteractionType) -> bool

If this Pact has any interactions of the given type

pub fn has_mixed_interactions(&self) -> bool

If this Pact has different types of interactions

pub fn filter_interactions( &self, interaction_type: V4InteractionType ) -> Vec<Box<dyn Interaction + Send + Sync + RefUnwindSafe>>

Returns all the interactions of the given type

pub fn find_interaction_with_id( &self, interaction_id: &str ) -> Option<&Box<dyn V4Interaction + Send + Sync + RefUnwindSafe>>

Find the interaction with the given ID

pub fn pact_from_json(json: &Value, source: &str) -> Result<V4Pact>

Parses a JSON value into a V4 Pact model

Trait Implementations

impl Clone for V4Pact

fn clone(&self) -> V4Pact

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for V4Pact

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for V4Pact

fn default() -> Self

Returns the “default value” for a type.

impl Pact for V4Pact

fn consumer(&self) -> Consumer

Consumer side of the pact

fn provider(&self) -> Provider

Provider side of the pact

fn interactions( &self ) -> Vec<Box<dyn Interaction + Send + Sync + RefUnwindSafe>>

Interactions in the Pact

fn interactions_mut(&mut self) -> Vec<&mut (dyn Interaction + Send + Sync)>

Mutable collection of interactions in the Pact

fn metadata(&self) -> BTreeMap<String, BTreeMap<String, String>>

Pact metadata

fn to_json(&self, pact_spec: PactSpecification) -> Result<Value>

Converts this pact to a Value struct.

fn as_request_response_pact(&self) -> Result<RequestResponsePact>

Attempt to downcast to a concrete Pact

fn as_message_pact(&self) -> Result<MessagePact>

Attempt to downcast to a concrete Message Pact

fn as_v4_pact(&self) -> Result<V4Pact>

Attempt to downcast to a concrete V4 Pact

fn specification_version(&self) -> PactSpecification

Specification version of this Pact

fn boxed(&self) -> Box<dyn Pact + Send + Sync + RefUnwindSafe>

Clones this Pact and wraps it in a Box

fn arced(&self) -> Arc<dyn Pact + Send + Sync + RefUnwindSafe>

Clones this Pact and wraps it in an Arc

fn thread_safe(&self) -> Arc<Mutex<dyn Pact + Send + Sync + RefUnwindSafe>>

Clones this Pact and wraps it in an Arc and Mutex

fn add_interaction(&mut self, interaction: &dyn Interaction) -> Result<()>

Adds an interactions in the Pact

fn requires_plugins(&self) -> bool

If this Pact needs any plugins loaded

fn plugin_data(&self) -> Vec<PluginData>

Plugins required for this Pact. These will be taken from the ‘plugins’ key in the pact metadata.

fn is_v4(&self) -> bool

If this is a V4 Pact

fn add_plugin( &mut self, name: &str, version: &str, plugin_data: Option<HashMap<String, Value>> ) -> Result<()>

Add the plugin and plugin data to this Pact. If an entry already exists for the plugin, the plugin data will be merged

fn add_md_version(&mut self, key: &str, version: &str)

Adds some version info to the Pact-Rust metadata section

impl PactJsonVerifier for V4Pact

fn verify_json( _path: &str, pact_json: &Value, _strict: bool, _spec_version: PactSpecification ) -> Vec<PactFileVerificationResult>

Verify the JSON format. Will return an error if the list contains any Error result

impl PartialEq for V4Pact

fn eq(&self, other: &V4Pact) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadWritePact for V4Pact

fn read_pact(path: &Path) -> Result<V4Pact>

Reads the pact file and parses the resulting JSON into a Pact struct

fn merge( &self, other: &dyn Pact ) -> Result<Box<dyn Pact + Send + Sync + RefUnwindSafe>>

Merges this pact with the other pact, and returns a new Pact with the interactions sorted. Returns an error if there is a merge conflict, which will occur if the other pact is a different type, or if a V3 Pact then if any interaction has the same description and provider state and the requests and responses are different.

fn default_file_name(&self) -> String

Determines the default file name for the pact. This is based on the consumer and provider names.

impl StructuralPartialEq for V4Pact