com.github.skjolber.mockito.soap.SoapServiceRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mockito-soap-cxf Show documentation
SOAP web-service mocking utility for CXF
There is a newer version: 2.0.1
package com.github.skjolber.mockito.soap;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Rule for mocking SOAP services.
 *
 * @author [email protected]
 */
public abstract class SoapServiceRule extends org.junit.rules.ExternalResource {

	public static SoapServiceRule newInstance() {
		return new SoapEndpointRule();
	}

	public static SoapEndpointRule newInstance(String ... portNames) {
		return new SoapEndpointRule(portNames);
	}

	public static SoapEndpointRule newInstance(int portRangeStart, int portRangeEnd, String ... portNames) {
		return new SoapEndpointRule(portRangeStart, portRangeEnd, portNames);
	}

	/**
	 * Create (and start) an endpoint.
	 *
	 * @param target instance calls are forwarded to
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param wsdlLocation wsdl location, or null
	 * @param schemaLocations schema locations, or null
	 * @param  the type of the mocked class
	 */
	public  void proxy(T target, Class port, String address, String wsdlLocation, List schemaLocations) {
		proxy(target, port, address, wsdlLocation, schemaLocations, null);
	}

	/**
	 * Create (and start) an endpoint with the given properties.
	 *
	 * @param target instance calls are forwarded to
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param wsdlLocation wsdl location, or null
	 * @param schemaLocations schema locations, or null
	 * @param properties additional properties, like mtom-enabled etc.
	 * @param  the type of the mocked class
	 */
	public abstract  void proxy(T target, Class port, String address, String wsdlLocation, List schemaLocations, Map properties);

	/**
	 * Create (and start) service endpoint with mock delegate. No schema validation.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address) {
		return mock(port, address, null, null, null);
	}

	/**
	 * Create (and start) service endpoint with mock delegate. No schema validation.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param properties additional properties, like mtom-enabled etc.
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address, Map properties) {
		return mock(port, address, null, null, properties);
	}

	/**
	 * Create (and start) service endpoint with mock delegate.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param wsdlLocation wsdl location
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address, String wsdlLocation) {
		return mock(port, address, wsdlLocation, null);
	}

	/**
	 * Create (and start) service endpoint with mock delegate.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param wsdlLocation wsdl location
	 * @param properties additional properties, like mtom-enabled etc.
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address, String wsdlLocation, Map properties) {
		if(wsdlLocation == null || wsdlLocation.isEmpty()) {
			throw new IllegalArgumentException("Expected WSDL location.");
		}
		return mock(port, address, wsdlLocation, null, properties);
	}

	/**
	 * Create (and start) service endpoint with mock delegate.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param schemaLocations schema locations
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address, List schemaLocations) {
		return mock(port, address, schemaLocations, null);
	}

	/**
	 * Create (and start) service with mock delegate and additional properties.
	 *
	 * @param port service class
	 * @param address address, i.e. http://localhost:1234
	 * @param schemaLocations schema locations
	 * @param properties additional properties, like mtom-enabled and so
	 * @param  class to be mocked
	 * @return the mockito mock to which server calls are delegated
	 */
	public  T mock(Class port, String address, List schemaLocations, Map properties) {
		if(schemaLocations == null || schemaLocations.isEmpty()) {
			throw new IllegalArgumentException("Expected XML Schema location(s).");
		}
		return mock(port, address, null, schemaLocations, properties);
	}

	private  T mock(Class port, String address, String wsdlLocation, List schemaLocations, Map properties) {
		// wrap the evaluator mock in proxy
		T mock = org.mockito.Mockito.mock(port);
		proxy(mock, port, address, wsdlLocation, schemaLocations, properties);
		return mock;
	}

	protected  void assertValidParams(T target, Class port, String address) {
		if(target == null) {
			throw new IllegalArgumentException("Expected proxy target");
		}
		if(port == null) {
			throw new IllegalArgumentException("Expect port class");
		}
		if(address == null) {
			throw new IllegalArgumentException("Expected address");
		}

		assertValidAddress(address);
	}

	protected void assertValidAddress(String address) {
		parsePort(address); // checks that address parsing is successful
	}

	protected int parsePort(String address) {
		try {
			return new URL(address).getPort();
		} catch (MalformedURLException e) {
			throw new IllegalArgumentException("Expected valid address: " + address, e);
		}
	}

	protected Map processProperties(Map properties, String wsdlLocation, List schemaLocations) {
		Map map = properties != null ? new HashMap<>(properties) : new HashMap<>();
		if(wsdlLocation != null || schemaLocations != null) {
			map.put("schema-validation-enabled", true);
		}
		return map;
	}

	public static Map properties(Object... properties) {
		verifyProperties(properties);

		HashMap map = new HashMap<>();
		if(properties != null) {
			for(int i = 0; i < properties.length; i+=2) {
				map.put((String)properties[i], properties[i+1]);
			}
		}

		return map;
	}

	protected static void verifyProperties(Object... properties) {
		if(properties != null) {
			if(properties.length % 2 != 0) {
				throw new IllegalArgumentException("Expected key-value properties, not length " + properties.length);
			}
			for(int i = 0; i < properties.length; i+=2) {
				if(!(properties[i] instanceof String)) {
					throw new IllegalArgumentException("Expected key-value with string key at index " + i);
				}
			}
		}
	}

	/**
	 * Stop services.
	 */
	public abstract void stop();

	/**
	 * (Re)start services.
	 */
	public abstract void start();

}