ca.uhn.fhir.test.utilities.server.RestfulServerConfigurerExtension Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR Test Utilities
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * 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.
 * #L%
 */
package ca.uhn.fhir.test.utilities.server;

import ca.uhn.fhir.rest.server.RestfulServer;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.springframework.util.Assert;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Supplier;

/**
 * This JUnit extension can be used to perform configuration of the
 * {@link RestfulServerExtension}, where non-static fields are available. This
 * is primarily useful for accessing Spring Test beans.
 */
public class RestfulServerConfigurerExtension implements BeforeEachCallback {

	private Supplier myRestfulServerExtensionSupplier;
	private RestfulServerExtension myRestfulServerExtension;
	private final List> myBeforeAllConsumers = new ArrayList<>();
	private final List> myBeforeEachConsumers = new ArrayList<>();

	/**
	 * Constructor
	 */
	public RestfulServerConfigurerExtension(RestfulServerExtension theRestfulServerExtension) {
		Assert.notNull(theRestfulServerExtension, "theRestfulServerExtension must not be null");
		myRestfulServerExtension = theRestfulServerExtension;
	}

	/**
	 * Constructor - Use this if the server is dependency injected
	 */
	public RestfulServerConfigurerExtension(Supplier theRestfulServerExtension) {
		Assert.notNull(theRestfulServerExtension, "theRestfulServerExtension must not be null");
		myRestfulServerExtensionSupplier = theRestfulServerExtension;
	}

	/**
	 * This callback will be invoked once after the server has started
	 */
	public RestfulServerConfigurerExtension withServerBeforeAll(Consumer theServer) {
		Assert.notNull(theServer, "theServer must not be null");
		myBeforeAllConsumers.add(theServer);
		return this;
	}

	/**
	 * This callback will be invoked before each test but after the server has started
	 */
	public RestfulServerConfigurerExtension withServerBeforeEach(Consumer theServer) {
		Assert.notNull(theServer, "theServer must not be null");
		myBeforeEachConsumers.add(theServer);
		return this;
	}

	@Override
	public void beforeEach(ExtensionContext theExtensionContext) throws Exception {
		ensureServerIsPresentAndRunning();

		String key = getClass().getName();

		// One time
		if (!myRestfulServerExtension.getRunningServerUserData().containsKey(key)) {
			myRestfulServerExtension.getRunningServerUserData().put(key, key);

			for (Consumer next : myBeforeAllConsumers) {
				myRestfulServerExtension.withServer(next::accept);
			}
		}

		// Every time
		for (Consumer next : myBeforeEachConsumers) {
			myRestfulServerExtension.withServer(next::accept);
		}
	}

	private void ensureServerIsPresentAndRunning() {
		if (myRestfulServerExtension == null) {
			myRestfulServerExtension = myRestfulServerExtensionSupplier.get();
		}
		Assert.isTrue(myRestfulServerExtension.isRunning(), "Server is not running");
	}
}