com.github.tomakehurst.wiremock.stubbing.StubMapping Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock Show documentation
Show all versions of wiremock Show documentation
A web service test double for all occasions
/*
* Copyright (C) 2011-2023 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.stubbing;
import static com.github.tomakehurst.wiremock.common.ParameterUtils.getFirstNonNull;
import com.fasterxml.jackson.annotation.*;
import com.github.tomakehurst.wiremock.common.Json;
import com.github.tomakehurst.wiremock.common.Metadata;
import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.PostServeActionDefinition;
import com.github.tomakehurst.wiremock.extension.ServeEventListenerDefinition;
import com.github.tomakehurst.wiremock.http.ResponseDefinition;
import com.github.tomakehurst.wiremock.matching.RequestPattern;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.UUID;
import java.util.stream.Collectors;
@JsonPropertyOrder({"id", "name", "request", "newRequest", "response", "uuid"})
@JsonIgnoreProperties({"$schema"}) // Allows this to be added as a hint to IDEs like VS Code
public class StubMapping {
public static final int DEFAULT_PRIORITY = 5;
private UUID uuid = UUID.randomUUID();
private String name;
private Boolean persistent;
private RequestPattern request;
private ResponseDefinition response;
private Integer priority;
private String scenarioName;
private String requiredScenarioState;
private String newScenarioState;
private List postServeActions;
private List serveEventListeners;
private Metadata metadata;
private long insertionIndex;
private boolean isDirty = true;
public StubMapping(RequestPattern requestPattern, ResponseDefinition response) {
setRequest(requestPattern);
this.response = response;
}
public StubMapping() {
// Concession to Jackson
}
public static final StubMapping NOT_CONFIGURED =
new StubMapping(null, ResponseDefinition.notConfigured());
public static StubMapping buildFrom(String mappingSpecJson) {
return Json.read(mappingSpecJson, StubMapping.class);
}
public static String buildJsonStringFor(StubMapping mapping) {
return Json.write(mapping);
}
public UUID getUuid() {
return uuid;
}
public void setId(UUID uuid) {
this.uuid = uuid;
}
public UUID getId() {
return uuid;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public void setUuid(UUID uuid) {
this.uuid = uuid;
}
public boolean shouldBePersisted() {
return persistent != null && persistent;
}
public Boolean isPersistent() {
return persistent;
}
public void setPersistent(Boolean persistent) {
this.persistent = persistent;
}
public RequestPattern getRequest() {
return getFirstNonNull(request, RequestPattern.ANYTHING);
}
public ResponseDefinition getResponse() {
return getFirstNonNull(response, ResponseDefinition.ok());
}
public void setRequest(RequestPattern request) {
this.request = request;
}
public void setResponse(ResponseDefinition response) {
this.response = response;
}
@Override
public String toString() {
return Json.write(this);
}
@JsonView(Json.PrivateView.class)
public long getInsertionIndex() {
return insertionIndex;
}
public void setInsertionIndex(long insertionIndex) {
this.insertionIndex = insertionIndex;
}
@JsonIgnore
public boolean isDirty() {
return isDirty;
}
@JsonIgnore
public void setDirty(boolean isDirty) {
this.isDirty = isDirty;
}
public Integer getPriority() {
return priority;
}
public void setPriority(Integer priority) {
this.priority = priority;
}
public String getScenarioName() {
return scenarioName;
}
public void setScenarioName(String scenarioName) {
this.scenarioName = scenarioName;
}
public String getRequiredScenarioState() {
return requiredScenarioState;
}
public void setRequiredScenarioState(String requiredScenarioState) {
this.requiredScenarioState = requiredScenarioState;
}
public String getNewScenarioState() {
return newScenarioState;
}
public void setNewScenarioState(String newScenarioState) {
this.newScenarioState = newScenarioState;
}
@JsonIgnore
public boolean isInScenario() {
return scenarioName != null;
}
@JsonIgnore
public boolean modifiesScenarioState() {
return newScenarioState != null;
}
@JsonIgnore
public boolean isIndependentOfScenarioState() {
return !isInScenario() || requiredScenarioState == null;
}
public int comparePriorityWith(StubMapping otherMapping) {
int thisPriority = priority != null ? priority : DEFAULT_PRIORITY;
int otherPriority = otherMapping.priority != null ? otherMapping.priority : DEFAULT_PRIORITY;
return thisPriority - otherPriority;
}
public List getPostServeActions() {
return postServeActions;
}
public List getServeEventListeners() {
return serveEventListeners;
}
public void setPostServeActions(List postServeActions) {
this.postServeActions = postServeActions;
}
@SuppressWarnings("unchecked")
@JsonProperty("postServeActions")
public void setPostServeActions(Object postServeActions) {
if (postServeActions == null) {
return;
}
// Ensure backwards compatibility with object/map form
if (Map.class.isAssignableFrom(postServeActions.getClass())) {
this.postServeActions =
((Map) postServeActions)
.entrySet().stream()
.map(
entry ->
new PostServeActionDefinition(
entry.getKey(), Parameters.from(entry.getValue())))
.collect(Collectors.toList());
} else if (List.class.isAssignableFrom(postServeActions.getClass())) {
this.postServeActions =
((List>) postServeActions)
.stream()
.map(item -> Json.mapToObject(item, PostServeActionDefinition.class))
.collect(Collectors.toList());
}
}
public void setServeEventListenerDefinitions(
List serveEventListeners) {
this.serveEventListeners = serveEventListeners;
}
@SuppressWarnings("unchecked")
@JsonProperty("serveEventListeners")
public void setServeEventListeners(Object serveEventListeners) {
if (serveEventListeners == null) {
return;
}
if (List.class.isAssignableFrom(serveEventListeners.getClass())) {
this.serveEventListeners =
((List>) serveEventListeners)
.stream()
.map(item -> Json.mapToObject(item, ServeEventListenerDefinition.class))
.collect(Collectors.toList());
}
}
public Metadata getMetadata() {
return metadata;
}
public void setMetadata(Metadata metadata) {
this.metadata = metadata;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
StubMapping that = (StubMapping) o;
return isDirty == that.isDirty
&& Objects.equals(uuid, that.uuid)
&& Objects.equals(request, that.request)
&& Objects.equals(response, that.response)
&& Objects.equals(priority, that.priority)
&& Objects.equals(scenarioName, that.scenarioName)
&& Objects.equals(requiredScenarioState, that.requiredScenarioState)
&& Objects.equals(newScenarioState, that.newScenarioState)
&& Objects.equals(postServeActions, that.postServeActions)
&& Objects.equals(metadata, that.metadata);
}
@Override
public int hashCode() {
return Objects.hash(
uuid,
request,
response,
priority,
scenarioName,
requiredScenarioState,
newScenarioState,
postServeActions,
metadata,
isDirty);
}
}