Class ProtoWireMockProtocol

Namespace

ProtoTest.WireMock

Assembly

ProtoTest.WireMock.dll

The WireMock protocol's identity: the key options and clients are registered under, the trace source its operations declare, and the observation kinds its fakes record. Matched requests reuse the REST response kind and payload, so the trace and any REST consumer read them as HTTP responses; stub registrations and unmatched requests use the package's own kinds.

public static class ProtoWireMockProtocol

Inheritance

object

ProtoWireMockProtocol

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

CoverageCategory

The coverage category the fake's collector reports under.

public const string CoverageCategory = "WireMock"

Field Value

string

FailureObservationKind

The observation kind an unmatched request records: the REST failure kind, with a RestFailureData payload, so an unmatched call never counts as covered.

public const string FailureObservationKind = "http.failure"

Field Value

string

Key

Stable protocol key WireMock registrations are tracked under.

public const string Key = "WireMock"

Field Value

string

Name

The capability and coverage name for the fake HTTP service.

public const string Name = "WireMock"

Field Value

string

Protocol

The protocol's identity: names, trace source, observation kind and coverage category.

public static readonly ProtoProtocol Protocol

Field Value

ProtoProtocol

ResponseObservationKind

The observation kind a matched request records: the REST response kind, with a RestResponseData payload, so matched fakes read as HTTP responses everywhere.

public const string ResponseObservationKind = "http.response"

Field Value

string

StartOperation

The operation a fake's server start is traced under.

public const string StartOperation = "wiremock.server.start"

Field Value

string

StopOperation

The operation a fake's server stop is traced under.

public const string StopOperation = "wiremock.server.stop"

Field Value

string

StubObservationKind

The observation kind a stub registration records. The coverage collector turns it into an uncovered item until a matched request for the stub arrives.

public const string StubObservationKind = "wiremock.stub"

Field Value

string

TraceSource

The trace source WireMock operations and events declare.

public const string TraceSource = "ProtoTest.WireMock"

Field Value

string

Methods

Identifier(string, string)

The observation identifier for one stub or request: the method and the path template, like the REST route identifier.

public static string Identifier(string method, string path)

Parameters

method string

path string

Returns

string

TargetName(string)

The observation target for one fake: prefixed so a fake never shares a target with a REST client of the same name.

public static string TargetName(string fakeName)

Parameters

fakeName string

Returns

string