org.springframework.test.web.client.SimpleRequestExpectationManager Maven / Gradle / Ivy
Show all versions of spring-test Show documentation
/*
* Copyright 2002-2018 the original author or authors.
*
* 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
*
* https://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 org.springframework.test.web.client;
import java.io.IOException;
import java.util.Iterator;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Simple {@code RequestExpectationManager} that matches requests to expectations
* sequentially, i.e. in the order of declaration of expectations.
*
* When request expectations have an expected count greater than one,
* only the first execution is expected to match the order of declaration.
* Subsequent request executions may be inserted anywhere thereafter.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.3
*/
public class SimpleRequestExpectationManager extends AbstractRequestExpectationManager {
/** Expectations in the order of declaration (count may be > 1). */
@Nullable
private Iterator expectationIterator;
/** Track expectations that have a remaining count. */
private final RequestExpectationGroup repeatExpectations = new RequestExpectationGroup();
@Override
protected void afterExpectationsDeclared() {
Assert.state(this.expectationIterator == null, "Expectations already declared");
this.expectationIterator = getExpectations().iterator();
}
@Override
protected RequestExpectation matchRequest(ClientHttpRequest request) throws IOException {
RequestExpectation expectation = this.repeatExpectations.findExpectation(request);
if (expectation == null) {
if (this.expectationIterator == null || !this.expectationIterator.hasNext()) {
throw createUnexpectedRequestError(request);
}
expectation = this.expectationIterator.next();
expectation.match(request);
}
this.repeatExpectations.update(expectation);
return expectation;
}
@Override
public void reset() {
super.reset();
this.expectationIterator = null;
this.repeatExpectations.reset();
}
}