com.github.tomakehurst.wiremock.matching.RequestPattern Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation
Show all versions of wiremock-standalone Show documentation
A web service test double for all occasions
/*
* Copyright (C) 2011 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.tomakehurst.wiremock.matching;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.github.tomakehurst.wiremock.client.BasicCredentials;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.common.Json;
import com.github.tomakehurst.wiremock.http.Cookie;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.RequestMethod;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableMap;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import static com.github.tomakehurst.wiremock.client.WireMock.anyUrl;
import static com.github.tomakehurst.wiremock.matching.RequestMatcherExtension.NEVER;
import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;
import static com.google.common.base.MoreObjects.firstNonNull;
import static com.google.common.collect.FluentIterable.from;
import static com.google.common.net.HttpHeaders.AUTHORIZATION;
public class RequestPattern implements NamedValueMatcher {
private final UrlPattern url;
private final RequestMethod method;
private final Map headers;
private final Map queryParams;
private final Map cookies;
private final BasicCredentials basicAuthCredentials;
private final List bodyPatterns;
private CustomMatcherDefinition customMatcherDefinition;
private ValueMatcher matcher;
private final RequestMatcher defaultMatcher = new RequestMatcher() {
@Override
public MatchResult match(Request request) {
return MatchResult.aggregate(
url.match(request.getUrl()),
method.match(request.getMethod()),
allHeadersMatchResult(request),
allQueryParamsMatch(request),
allCookiesMatch(request),
allBodyPatternsMatch(request)
);
}
@Override
public String getName() {
return "default";
}
};
public RequestPattern(UrlPattern url,
RequestMethod method,
Map headers,
Map queryParams,
Map cookies,
BasicCredentials basicAuthCredentials,
List bodyPatterns,
CustomMatcherDefinition customMatcherDefinition) {
this.url = url;
this.method = firstNonNull(method, RequestMethod.ANY);
this.headers = headers;
this.queryParams = queryParams;
this.cookies = cookies;
this.basicAuthCredentials = basicAuthCredentials;
this.bodyPatterns = bodyPatterns;
this.matcher = defaultMatcher;
this.customMatcherDefinition = customMatcherDefinition;
}
@JsonCreator
public RequestPattern(@JsonProperty("url") String url,
@JsonProperty("urlPattern") String urlPattern,
@JsonProperty("urlPath") String urlPath,
@JsonProperty("urlPathPattern") String urlPathPattern,
@JsonProperty("method") RequestMethod method,
@JsonProperty("headers") Map headers,
@JsonProperty("queryParameters") Map queryParams,
@JsonProperty("cookies") Map cookies,
@JsonProperty("basicAuth") BasicCredentials basicAuthCredentials,
@JsonProperty("bodyPatterns") List bodyPatterns,
@JsonProperty("customMatcher") CustomMatcherDefinition customMatcherDefinition) {
this(
UrlPattern.fromOneOf(url, urlPattern, urlPath, urlPathPattern),
method,
headers,
queryParams,
cookies,
basicAuthCredentials,
bodyPatterns,
customMatcherDefinition
);
}
public static RequestPattern ANYTHING = new RequestPattern(
WireMock.anyUrl(),
RequestMethod.ANY,
null,
null,
null,
null,
null,
null
);
public RequestPattern(ValueMatcher customMatcher) {
this(null, null, null, null, null, null, null, null);
this.matcher = customMatcher;
}
public RequestPattern(CustomMatcherDefinition customMatcherDefinition) {
this(null, null, null, null, null, null, null, customMatcherDefinition);
}
@Override
public MatchResult match(Request request) {
return match(request, Collections.emptyMap());
}
public static RequestPattern everything() {
return newRequestPattern(RequestMethod.ANY, anyUrl()).build();
}
public MatchResult match(Request request, Map customMatchers) {
if (customMatcherDefinition != null) {
RequestMatcherExtension requestMatcher =
firstNonNull(customMatchers.get(customMatcherDefinition.getName()), NEVER);
return requestMatcher.match(request, customMatcherDefinition.getParameters());
}
return matcher.match(request);
}
private MatchResult allCookiesMatch(final Request request) {
if (cookies != null && !cookies.isEmpty()) {
return MatchResult.aggregate(
from(cookies.entrySet())
.transform(new Function, MatchResult>() {
public MatchResult apply(Map.Entry cookiePattern) {
Cookie cookie =
firstNonNull(request.getCookies().get(cookiePattern.getKey()), Cookie.absent());
return cookiePattern.getValue().match(cookie.getValue());
}
}).toList()
);
}
return MatchResult.exactMatch();
}
private MatchResult allHeadersMatchResult(final Request request) {
Map combinedHeaders = combineBasicAuthAndOtherHeaders();
if (combinedHeaders != null && !combinedHeaders.isEmpty()) {
return MatchResult.aggregate(
from(combinedHeaders.entrySet())
.transform(new Function, MatchResult>() {
public MatchResult apply(Map.Entry headerPattern) {
return headerPattern.getValue().match(request.header(headerPattern.getKey()));
}
}).toList()
);
}
return MatchResult.exactMatch();
}
public Map combineBasicAuthAndOtherHeaders() {
if (basicAuthCredentials == null) {
return headers;
}
Map combinedHeaders = headers;
ImmutableMap.Builder allHeadersBuilder =
ImmutableMap.builder()
.putAll(firstNonNull(combinedHeaders, Collections.emptyMap()));
allHeadersBuilder.put(AUTHORIZATION, basicAuthCredentials.asAuthorizationMultiValuePattern());
combinedHeaders = allHeadersBuilder.build();
return combinedHeaders;
}
private MatchResult allQueryParamsMatch(final Request request) {
if (queryParams != null && !queryParams.isEmpty()) {
return MatchResult.aggregate(
from(queryParams.entrySet())
.transform(new Function, MatchResult>() {
public MatchResult apply(Map.Entry queryParamPattern) {
return queryParamPattern.getValue().match(request.queryParameter(queryParamPattern.getKey()));
}
}).toList()
);
}
return MatchResult.exactMatch();
}
private MatchResult allBodyPatternsMatch(final Request request) {
if (bodyPatterns != null && !bodyPatterns.isEmpty() && request.getBody() != null) {
return MatchResult.aggregate(
from(bodyPatterns).transform(new Function() {
@Override
public MatchResult apply(StringValuePattern pattern) {
return pattern.match(request.getBodyAsString());
}
}).toList()
);
}
return MatchResult.exactMatch();
}
public boolean isMatchedBy(Request request, Map customMatchers) {
return match(request, customMatchers).isExactMatch();
}
public String getUrl() {
return urlPatternOrNull(UrlPattern.class, false);
}
public String getUrlPattern() {
return urlPatternOrNull(UrlPattern.class, true);
}
public String getUrlPath() {
return urlPatternOrNull(UrlPathPattern.class, false);
}
public String getUrlPathPattern() {
return urlPatternOrNull(UrlPathPattern.class, true);
}
@JsonIgnore
public UrlPattern getUrlMatcher() {
return url;
}
private String urlPatternOrNull(Class clazz, boolean regex) {
return (url != null && url.getClass().equals(clazz) && url.isRegex() == regex && url.isSpecified()) ? url.getPattern().getValue() : null;
}
public RequestMethod getMethod() {
return method;
}
public Map getHeaders() {
return headers;
}
public BasicCredentials getBasicAuthCredentials() {
return basicAuthCredentials;
}
public Map getQueryParameters() {
return queryParams;
}
public Map getCookies() {
return cookies;
}
public List getBodyPatterns() {
return bodyPatterns;
}
public CustomMatcherDefinition getCustomMatcher() {
return customMatcherDefinition;
}
@Override
public String getName() {
return "requestMatching";
}
@Override
public String getExpected() {
return toString();
}
public boolean hasCustomMatcher() {
return matcher != defaultMatcher;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RequestPattern that = (RequestPattern) o;
return Objects.equals(url, that.url) &&
Objects.equals(method, that.method) &&
Objects.equals(headers, that.headers) &&
Objects.equals(queryParams, that.queryParams) &&
Objects.equals(cookies, that.cookies) &&
Objects.equals(basicAuthCredentials, that.basicAuthCredentials) &&
Objects.equals(bodyPatterns, that.bodyPatterns) &&
Objects.equals(customMatcherDefinition, that.customMatcherDefinition) &&
Objects.equals(matcher, that.matcher);
}
@Override
public int hashCode() {
return Objects.hash(url, method, headers, queryParams, cookies, basicAuthCredentials, bodyPatterns, customMatcherDefinition, matcher);
}
@Override
public String toString() {
return Json.write(this);
}
public static Predicate thatMatch(final RequestPattern pattern) {
return new Predicate() {
@Override
public boolean apply(Request request) {
return pattern.match(request).isExactMatch();
}
};
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy