software.xdev.mockserver.matchers.AbstractHttpRequestMatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of server Show documentation
MockServer NeoLight Netty Server
There is a newer version: 1.0.8
/*
 * Copyright © 2024 XDEV Software (https://xdev.software)
 *
 * 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 software.xdev.mockserver.matchers;

import static software.xdev.mockserver.character.Character.NEW_LINE;

import java.util.Objects;

import software.xdev.mockserver.configuration.ServerConfiguration;
import software.xdev.mockserver.mock.Expectation;
import software.xdev.mockserver.mock.listeners.MockServerMatcherNotifier;
import software.xdev.mockserver.model.RequestDefinition;


public abstract class AbstractHttpRequestMatcher extends NotMatcher implements HttpRequestMatcher
{
	protected static final String REQUEST_DID_NOT_MATCH = "request:{} didn't match";
	protected static final String REQUEST_MATCHER = " request matcher";
	protected static final String EXPECTATION = " expectation";
	protected static final String BECAUSE = ":{}because:{}";
	protected static final String REQUEST_DID_MATCH = "request: {} matched request: {}";
	protected static final String EXPECTATION_DID_MATCH = "request: {} matched" + EXPECTATION + ": {}";
	protected static final String DID_NOT_MATCH = " didn't match";
	protected static final String MATCHED = " matched";
	protected static final String COLON_NEW_LINES = ": " + NEW_LINE + NEW_LINE;
	
	protected final ServerConfiguration configuration;
	private int hashCode;
	private boolean isBlank;
	private boolean responseInProgress;
	private MockServerMatcherNotifier.Cause source;
	protected boolean controlPlaneMatcher;
	protected Expectation expectation;
	protected String didNotMatchRequestBecause = REQUEST_DID_NOT_MATCH + REQUEST_MATCHER + BECAUSE;
	protected String didNotMatchExpectationBecause = REQUEST_DID_NOT_MATCH + EXPECTATION + BECAUSE;
	protected String didNotMatchExpectationWithoutBecause = REQUEST_DID_NOT_MATCH + EXPECTATION;
	
	protected AbstractHttpRequestMatcher(final ServerConfiguration configuration)
	{
		this.configuration = configuration;
	}
	
	public void setDescription(final String description)
	{
		this.didNotMatchRequestBecause = REQUEST_DID_NOT_MATCH + description + REQUEST_MATCHER + BECAUSE;
		this.didNotMatchExpectationBecause = REQUEST_DID_NOT_MATCH + description + EXPECTATION + BECAUSE;
		this.didNotMatchExpectationWithoutBecause = REQUEST_DID_NOT_MATCH + description + EXPECTATION;
	}
	
	@Override
	public boolean update(final Expectation expectation)
	{
		if(this.expectation != null && this.expectation.equals(expectation))
		{
			return false;
		}
		else
		{
			this.controlPlaneMatcher = false;
			this.expectation = expectation;
			this.hashCode = 0;
			this.isBlank = expectation.getHttpRequest() == null;
			this.apply(expectation.getHttpRequest());
			return true;
		}
	}
	
	@Override
	public boolean update(final RequestDefinition requestDefinition)
	{
		this.controlPlaneMatcher = true;
		this.expectation = null;
		this.hashCode = 0;
		this.isBlank = requestDefinition == null;
		return this.apply(requestDefinition);
	}
	
	public void setControlPlaneMatcher(final boolean controlPlaneMatcher)
	{
		this.controlPlaneMatcher = controlPlaneMatcher;
	}
	
	abstract boolean apply(RequestDefinition requestDefinition);
	
	@Override
	public boolean matches(final RequestDefinition requestDefinition)
	{
		return this.matches(null, requestDefinition);
	}
	
	@Override
	public abstract boolean matches(MatchDifference context, RequestDefinition requestDefinition);
	
	@Override
	public Expectation getExpectation()
	{
		return this.expectation;
	}
	
	@Override
	public boolean isResponseInProgress()
	{
		return this.responseInProgress;
	}
	
	@Override
	public HttpRequestMatcher setResponseInProgress(final boolean responseInProgress)
	{
		this.responseInProgress = responseInProgress;
		return this;
	}
	
	@Override
	public MockServerMatcherNotifier.Cause getSource()
	{
		return this.source;
	}
	
	@Override
	public AbstractHttpRequestMatcher withSource(final MockServerMatcherNotifier.Cause source)
	{
		this.source = source;
		return this;
	}
	
	@Override
	public boolean isBlank()
	{
		return this.isBlank;
	}
	
	@Override
	public boolean isActive()
	{
		return this.expectation == null || this.expectation.isActive();
	}
	
	@Override
	public boolean equals(final Object o)
	{
		if(this == o)
		{
			return true;
		}
		if(o == null || this.getClass() != o.getClass())
		{
			return false;
		}
		if(this.hashCode() != o.hashCode())
		{
			return false;
		}
		final HttpRequestPropertiesMatcher that = (HttpRequestPropertiesMatcher)o;
		return Objects.equals(this.expectation, that.expectation);
	}
	
	@Override
	public int hashCode()
	{
		if(this.hashCode == 0)
		{
			this.hashCode = Objects.hash(this.expectation);
		}
		return this.hashCode;
	}
}