Class WireMock
java.lang.Object
com.github.tomakehurst.wiremock.client.WireMock
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringValuePatternabsent()static AfterDateTimePatternstatic AfterDateTimePatternafter(LocalDateTime dateTime) static AfterDateTimePatternafter(ZonedDateTime dateTime) static AfterDateTimePatternafterNow()static MultipartValuePatternBuilderstatic MultipartValuePatternBuilderaMultipart(String name) static StringValuePatternand(StringValuePattern... matchers) static MappingBuilderany(UrlPattern urlPattern) static RequestPatternBuilderanyRequestedFor(UrlPattern urlPattern) static UrlPatternanyUrl()static ResponseDefinitionBuilderstatic ResponseDefinitionBuilderstatic ResponseDefinitionBuilderstatic BeforeDateTimePatternstatic BeforeDateTimePatternbefore(LocalDateTime dateTime) static BeforeDateTimePatternbefore(ZonedDateTime dateTime) static BeforeDateTimePatternstatic BinaryEqualToPatternbinaryEqualTo(byte[] content) static BinaryEqualToPatternbinaryEqualTo(String content) static voidstatic voidconfigureFor(int port) static voidconfigureFor(WireMock client) static voidconfigureFor(String host, int port) static voidconfigureFor(String host, int port, String urlPathPrefix) static voidconfigureFor(String scheme, String host, int port) static voidconfigureFor(String scheme, String host, int port, String urlPathPrefix) static voidconfigureFor(String scheme, String host, int port, String proxyHost, int proxyPort) static StringValuePatterncontaining(String value) static WireMockBuildercreate()static ResponseDefinitionBuildercreated()static MappingBuilderdelete(UrlPattern urlPattern) static MappingBuildervoiddeleteMessageServeEvent(UUID eventId) voidstatic RequestPatternBuilderdeleteRequestedFor(UrlPattern urlPattern) static voideditStub(MappingBuilder mappingBuilder) voideditStubMapping(MappingBuilder mappingBuilder) static StringValuePatternstatic EqualToDateTimePatternequalToDateTime(String dateTimeSpec) static EqualToDateTimePatternequalToDateTime(LocalDateTime dateTime) static EqualToDateTimePatternequalToDateTime(ZonedDateTime dateTime) static StringValuePatternequalToIgnoreCase(String value) static StringValuePatternequalToJson(String value) static StringValuePatternequalToJson(String value, boolean ignoreArrayOrder, boolean ignoreExtraElements) static StringValuePatternequalToNumber(Number value) static EqualToXmlPatternequalToXml(String value) static EqualToXmlPatternequalToXml(String value, boolean enablePlaceholders) static EqualToXmlPatternequalToXml(String value, boolean enablePlaceholders, boolean ignoreOrderOfSameNode) static EqualToXmlPatternequalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex) static EqualToXmlPatternequalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode) static EqualToXmlPatternequalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode, EqualToXmlPattern.NamespaceAwareness namespaceAwareness) static EqualToXmlPatternequalToXml(String value, EqualToXmlPattern.NamespaceAwareness namespaceAwareness) static CountMatchingStrategyexactly(int expected) find(RequestPatternBuilder requestPatternBuilder) static List<LoggedRequest>findAll(RequestPatternBuilder requestPatternBuilder) static List<MessageServeEvent>findAllMessageEvents(MessagePattern pattern) findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder) findAllStubsByMetadata(StringValuePattern pattern) findMessageEvents(MessagePattern pattern) static List<MessageStubMapping>findNearMissesFor(RequestPatternBuilder requestPatternBuilder) findNearMissesFor(LoggedRequest loggedRequest) static List<StubMapping>findStubsByMetadata(StringValuePattern pattern) findTopNearMissesFor(LoggedRequest loggedRequest) static List<LoggedRequest>static ResponseDefinitionBuilderstatic MappingBuilderget(UrlPattern urlPattern) static MappingBuilderstatic List<MessageServeEvent>static List<ServeEvent>static List<ServeEvent>getAllServeEvents(ServeEventQuery query) static MessageServeEventstatic MappingBuildergetOrHead(UrlPattern urlPattern) A mapping builder that can be used for both GET and HEAD http method.static RecordingStatusResultstatic RequestPatternBuildergetRequestedFor(UrlPattern urlPattern) getServeEvents(ServeEventQuery query) static GlobalSettingsstatic StubMappinggetStubMapping(UUID id) static StubMappinggivenThat(MappingBuilder mappingBuilder) static StringValuePatterngreaterThanEqualNumber(Number value) static StringValuePatterngreaterThanNumber(Number value) static MultiValuePatternhavingExactly(StringValuePattern... valuePatterns) static MultiValuePatternhavingExactly(String... values) static MappingBuilderhead(UrlPattern urlPattern) static RequestPatternBuilderheadRequestedFor(UrlPattern urlPattern) voidimportStubMappings(StubImport stubImport) voidimportStubMappings(StubImportBuilder stubImport) static voidimportStubs(StubImport stubImport) static voidimportStubs(StubImportBuilder stubImport) static MultiValuePatternincluding(StringValuePattern... valuePatterns) static MultiValuePatternstatic EqualToDateTimePatternisNow()static ResponseDefinitionBuilderjsonResponse(Object body, int status) static ResponseDefinitionBuilderjsonResponse(String body, int status) static CountMatchingStrategylessThan(int expected) static StringValuePatternlessThanEqualNumber(Number value) static StringValuePatternlessThanNumber(Number value) static CountMatchingStrategylessThanOrExactly(int expected) static ListMessageChannelsResultstatic ListStubMappingsResultvoidloadMappingsFrom(File rootDir) voidloadMappingsFrom(String rootDir) static MatchesXPathPatternmatchesXPathWithSubMatcher(String value, StringValuePattern valuePattern) static StringValuePatternstatic StringValuePatternmatchingJsonPath(String value) static StringValuePatternmatchingJsonPath(String value, StringValuePattern valuePattern) static StringValuePatternmatchingJsonSchema(String schema) static StringValuePatternmatchingJsonSchema(String schema, WireMock.JsonSchemaVersion jsonSchemaVersion) static MatchesXPathPatternmatchingXPath(String value) static StringValuePatternmatchingXPath(String value, StringValuePattern valuePattern) static StringValuePatternmatchingXPath(String value, Map<String, String> namespaces) static MessageStubMapping.Buildermessage()static MessageStubMappingmessageStubFor(MessageStubMappingBuilder builder) static MessageStubMappingmessageStubFor(MessageStubMapping messageStubMapping) static CountMatchingStrategymoreThan(int expected) static CountMatchingStrategymoreThanOrExactly(int expected) static ResponseDefinitionBuilderstatic StringValuePatternnot(StringValuePattern unexpectedPattern) static StringValuePatternnotContaining(String value) static ResponseDefinitionBuildernotFound()static StringValuePatternnotMatching(String regex) static MultiValuePatternnoValues()static ResponseDefinitionBuilderok()static ResponseDefinitionBuilderstatic ResponseDefinitionBuilderokForContentType(String contentType, String body) static ResponseDefinitionBuilderstatic ResponseDefinitionBuilderstatic ResponseDefinitionBuilderstatic MappingBuilderoptions(UrlPattern urlPattern) static RequestPatternBuilderoptionsRequestedFor(UrlPattern urlPattern) static StringValuePatternor(StringValuePattern... matchers) static MappingBuilderpatch(UrlPattern urlPattern) static MappingBuilderstatic RequestPatternBuilderpatchRequestedFor(UrlPattern urlPattern) static ResponseDefinitionBuilderpermanentRedirect(String location) static MappingBuilderpost(UrlPattern urlPattern) static MappingBuilderstatic RequestPatternBuilderpostRequestedFor(UrlPattern urlPattern) static MappingBuilderproxyAllTo(String url) static MappingBuilderput(UrlPattern urlPattern) static MappingBuilderstatic RequestPatternBuilderputRequestedFor(UrlPattern urlPattern) static MappingBuilderquery(UrlPattern urlPattern) static MappingBuilderstatic RequestPatternBuilderqueryRequestedFor(UrlPattern urlPattern) static RecordSpecBuilderregister(MappingBuilder mappingBuilder) voidregister(StubMapping mapping) registerMessageStub(MessageStubMapping messageStubMapping) static voidvoidvoidremoveEvent(UUID eventId) removeEvents(RequestPatternBuilder requestPatternBuilder) removeEventsByMetadata(StringValuePattern pattern) static List<ServeEvent>voidremoveMessageEvents(MessagePattern pattern) static voidremoveMessageServeEvent(UUID eventId) static FindMessageServeEventsResultstatic FindMessageServeEventsResultstatic voidstatic voidstatic voidremoveServeEvent(UUID eventId) static List<ServeEvent>removeServeEvents(RequestPatternBuilder requestPatternBuilder) static voidremoveStub(MappingBuilder mappingBuilder) static voidremoveStub(StubMapping stubMapping) static voidremoveStub(UUID id) voidremoveStubMapping(MappingBuilder mappingBuilder) voidremoveStubMapping(StubMapping stubMapping) voidvoidremoveStubMappings(List<StubMapping> stubs) static voidremoveStubs(List<StubMapping> stubs) static voidremoveStubsByMetadata(StringValuePattern pattern) voidstatic MappingBuilderrequest(RequestMethod method, UrlPattern urlPattern) static MappingBuilderrequest(String method, UrlPattern urlPattern) static RequestPatternBuilderrequestedFor(String method, UrlPattern urlPattern) static RequestPatternBuilderrequestMadeFor(ValueMatcher<Request> requestMatcher) static RequestPatternBuilderrequestMadeFor(String customMatcherName, Parameters parameters) static MappingBuilderrequestMatching(ValueMatcher<Request> requestMatcher) static MappingBuilderrequestMatching(String customRequestMatcherName) static MappingBuilderrequestMatching(String customRequestMatcherName, Parameters parameters) static voidreset()voidstatic voidstatic voidvoidstatic voidvoidstatic voidvoidstatic voidresetScenario(String name) voidvoidresetScenarioState(String name) static voidvoidstatic voidvoidstatic ResponseDefinitionBuilderstatic SendMessageActionBuilderstatic SendMessageActionBuildersendMessage(String message) static ResponseDefinitionBuilderstatic ResponseDefinitionBuilderstatic voidsetGlobalFixedDelay(int milliseconds) voidsetGlobalFixedDelayVariable(int milliseconds) static voidsetGlobalRandomDelay(DelayDistribution distribution) voidsetGlobalRandomDelayVariable(DelayDistribution distribution) static voidsetScenarioState(String name, String state) voidsetSingleScenarioState(String name, String state) voidshutdown()static voidstatic List<StubMapping>static List<StubMapping>static voidstatic voidstatic voidstartRecording(String targetBaseUrl) voidvoidvoidstartStubRecording(String targetBaseUrl) static ResponseDefinitionBuilderstatus(int status) static SnapshotRecordResultstatic StubMappingstubFor(MappingBuilder mappingBuilder) static ResponseDefinitionBuildertemporaryRedirect(String location) static MappingBuildertrace(UrlPattern urlPattern) static RequestPatternBuildertraceRequestedFor(UrlPattern urlPattern) static ResponseDefinitionBuildervoidupdateGlobalSettings(GlobalSettings settings) static voidupdateSettings(GlobalSettings settings) static UrlPatternurlEqualTo(String testUrl) static UrlPatternurlEqualTo(org.wiremock.url.PathAndQuery testUrl) static UrlPatternurlMatching(String urlRegex) static UrlPathPatternurlPathEqualTo(String testUrl) static UrlPathPatternurlPathEqualTo(org.wiremock.url.Path testUrl) static UrlPathPatternurlPathMatching(String urlRegex) static UrlPathPatternurlPathTemplate(String pathTemplate) static voidverify(int count, RequestPatternBuilder requestPatternBuilder) static voidverify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder) static voidverify(RequestPatternBuilder requestPatternBuilder) static voidverifyMessageEvent(int expectedCount, MessagePattern pattern) static voidverifyMessageEvent(CountMatchingStrategy expectedCount, MessagePattern pattern) static voidverifyMessageEvent(MessagePattern pattern) voidverifyThat(int expectedCount, RequestPatternBuilder requestPatternBuilder) voidverifyThat(CountMatchingStrategy expectedCount, RequestPatternBuilder requestPatternBuilder) voidverifyThat(RequestPatternBuilder requestPatternBuilder) voidverifyThatMessageEvent(int expectedCount, MessagePattern pattern) voidverifyThatMessageEvent(CountMatchingStrategy expectedCount, MessagePattern pattern) voidverifyThatMessageEvent(MessagePattern pattern) waitForMessage(MessagePattern pattern, Duration maxWait) static Optional<MessageServeEvent>waitForMessageEvent(MessagePattern pattern, Duration maxWait) static List<MessageServeEvent>waitForMessageEvents(MessagePattern pattern, int count, Duration maxWait) waitForMessages(MessagePattern pattern, int count, Duration maxWait)
-
Constructor Details
-
WireMock
-
WireMock
public WireMock(int port)
-
-
Method Details
-
create
-
givenThat
-
stubFor
-
editStub
-
removeStub
-
removeStub
-
removeStub
-
listAllStubMappings
-
getSingleStubMapping
-
configureFor
public static void configureFor(int port) -
configureFor
-
configureFor
-
configureFor
-
configureFor
-
configureFor
-
configureFor
-
configure
public static void configure() -
equalTo
-
equalToNumber
-
greaterThanNumber
-
greaterThanEqualNumber
-
lessThanNumber
-
lessThanEqualNumber
-
binaryEqualTo
-
binaryEqualTo
-
equalToIgnoreCase
-
equalToJson
-
equalToJson
public static StringValuePattern equalToJson(String value, boolean ignoreArrayOrder, boolean ignoreExtraElements) -
matchingJsonPath
-
matchingJsonPath
-
matchingJsonSchema
-
matchingJsonSchema
public static StringValuePattern matchingJsonSchema(String schema, WireMock.JsonSchemaVersion jsonSchemaVersion) -
equalToXml
-
equalToXml
public static EqualToXmlPattern equalToXml(String value, EqualToXmlPattern.NamespaceAwareness namespaceAwareness) -
equalToXml
-
equalToXml
public static EqualToXmlPattern equalToXml(String value, boolean enablePlaceholders, boolean ignoreOrderOfSameNode) -
equalToXml
public static EqualToXmlPattern equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex) -
equalToXml
public static EqualToXmlPattern equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode) -
equalToXml
public static EqualToXmlPattern equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode, EqualToXmlPattern.NamespaceAwareness namespaceAwareness) -
matchingXPath
-
matchingXPath
-
matchingXPath
-
matchesXPathWithSubMatcher
public static MatchesXPathPattern matchesXPathWithSubMatcher(String value, StringValuePattern valuePattern) -
containing
-
notContaining
-
not
-
matching
-
notMatching
-
before
-
before
-
before
-
beforeNow
-
equalToDateTime
-
equalToDateTime
-
equalToDateTime
-
isNow
-
after
-
after
-
after
-
afterNow
-
absent
-
and
-
or
-
saveMappings
public void saveMappings() -
saveAllMappings
public static void saveAllMappings() -
removeMappings
public void removeMappings() -
removeAllMappings
public static void removeAllMappings() -
resetMappings
public void resetMappings() -
reset
public static void reset() -
resetAllRequests
public static void resetAllRequests() -
resetRequests
public void resetRequests() -
resetScenarios
public void resetScenarios() -
resetScenario
-
resetScenarioState
-
setScenarioState
-
setSingleScenarioState
-
getAllScenarios
-
getScenarios
-
resetAllScenarios
public static void resetAllScenarios() -
resetToDefaultMappings
public void resetToDefaultMappings() -
resetToDefault
public static void resetToDefault() -
register
-
register
-
editStubMapping
-
removeStubMapping
-
removeStubMapping
-
removeStubMapping
-
allStubMappings
-
getStubMapping
-
urlEqualTo
-
urlEqualTo
-
urlMatching
-
urlPathEqualTo
-
urlPathEqualTo
-
urlPathMatching
-
urlPathTemplate
-
havingExactly
-
havingExactly
-
including
-
including
-
noValues
-
anyUrl
-
lessThan
-
lessThanOrExactly
-
exactly
-
moreThanOrExactly
-
moreThan
-
get
-
post
-
put
-
delete
-
patch
-
head
-
options
-
trace
-
any
-
query
-
getOrHead
A mapping builder that can be used for both GET and HEAD http method. Returns a response body in case for GET and not in case of HEAD method. In case of tie the request is treated as a GET request- Parameters:
urlPattern- for the specified method- Returns:
- a mapping builder for
RequestMethod.GET_OR_HEADhttp method
-
request
-
request
-
requestMatching
-
requestMatching
public static MappingBuilder requestMatching(String customRequestMatcherName, Parameters parameters) -
requestMatching
-
aResponse
-
ok
-
ok
-
okForContentType
-
okJson
-
okXml
-
okTextXml
-
jsonResponse
-
jsonResponse
-
proxyAllTo
-
get
-
post
-
put
-
delete
-
patch
-
query
-
created
-
noContent
-
permanentRedirect
-
temporaryRedirect
-
seeOther
-
badRequest
-
badRequestEntity
-
unauthorized
-
forbidden
-
notFound
-
serverError
-
status
-
verifyThat
-
verifyThat
-
verifyThat
public void verifyThat(CountMatchingStrategy expectedCount, RequestPatternBuilder requestPatternBuilder) -
verify
-
verify
-
verify
public static void verify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder) -
find
-
findAll
-
getAllServeEvents
-
getServeEvents
-
getAllServeEvents
-
getServeEvents
-
removeServeEvent
-
removeEvent
-
removeEvents
-
removeServeEvents
-
removeEventsByStubMetadata
-
removeEventsByMetadata
-
getRequestedFor
-
postRequestedFor
-
putRequestedFor
-
deleteRequestedFor
-
patchRequestedFor
-
headRequestedFor
-
optionsRequestedFor
-
traceRequestedFor
-
anyRequestedFor
-
queryRequestedFor
-
requestedFor
-
requestMadeFor
-
requestMadeFor
-
setGlobalFixedDelay
public static void setGlobalFixedDelay(int milliseconds) -
setGlobalFixedDelayVariable
public void setGlobalFixedDelayVariable(int milliseconds) -
setGlobalRandomDelay
-
setGlobalRandomDelayVariable
-
updateSettings
-
updateGlobalSettings
-
shutdown
public void shutdown() -
shutdownServer
public static void shutdownServer() -
findNearMissesForAllUnmatched
-
findNearMissesForAllUnmatchedRequests
-
findUnmatchedRequests
-
findAllUnmatchedRequests
-
findNearMissesFor
-
findTopNearMissesFor
-
findNearMissesFor
-
findAllNearMissesFor
-
loadMappingsFrom
-
loadMappingsFrom
-
snapshotRecord
-
snapshotRecord
-
takeSnapshotRecording
-
takeSnapshotRecording
-
aMultipart
-
aMultipart
-
startRecording
-
startRecording
public static void startRecording() -
startRecording
-
startStubRecording
-
startStubRecording
public void startStubRecording() -
startStubRecording
-
stopRecording
-
stopStubRecording
-
getRecordingStatus
-
getStubRecordingStatus
-
recordSpec
-
findAllStubsByMetadata
-
findStubsByMetadata
-
removeStubsByMetadataPattern
-
removeStubsByMetadata
-
importStubMappings
-
importStubMappings
-
importStubs
-
importStubs
-
removeStubMappings
-
removeStubs
-
getGlobalSettings
-
getSettings
-
message
-
sendMessage
-
sendMessage
-
messageStubFor
-
registerMessageStub
-
messageStubFor
-
registerMessageStub
-
removeMessageStub
-
deleteMessageStub
-
resetMessageStubs
public static void resetMessageStubs() -
resetAllMessageStubs
public void resetAllMessageStubs() -
findMessageStubsByMetadata
-
findAllMessageStubsByMetadata
-
removeMessageStubsByMetadata
-
removeAllMessageStubsByMetadata
-
listAllMessageStubMappings
-
allMessageStubMappings
-
listAllMessageChannels
-
allMessageChannels
-
getAllMessageServeEvents
-
getMessageServeEvents
-
getMessageServeEvent
-
getMessageServeEventById
-
removeMessageServeEvent
-
deleteMessageServeEvent
-
findAllMessageEvents
-
findMessageEvents
-
verifyMessageEvent
-
verifyThatMessageEvent
-
verifyMessageEvent
-
verifyThatMessageEvent
-
verifyMessageEvent
-
verifyThatMessageEvent
-
waitForMessageEvent
public static Optional<MessageServeEvent> waitForMessageEvent(MessagePattern pattern, Duration maxWait) -
waitForMessage
-
waitForMessageEvents
public static List<MessageServeEvent> waitForMessageEvents(MessagePattern pattern, int count, Duration maxWait) -
waitForMessages
-
resetMessageJournal
public static void resetMessageJournal() -
resetMessages
public void resetMessages() -
removeMessageServeEventsMatching
-
removeMessageEvents
-
removeMessageServeEventsForStubsMatchingMetadata
public static FindMessageServeEventsResult removeMessageServeEventsForStubsMatchingMetadata(StringValuePattern pattern) -
removeMessageEventsForStubsMatchingMetadata
public FindMessageServeEventsResult removeMessageEventsForStubsMatchingMetadata(StringValuePattern pattern)
-