io.pivotal.cfenv.test.AbstractCfEnvTests Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-cfenv-test-support Show documentation
Java CF Env Test Support Library
The newest version!
/*
 * Copyright 2019 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 io.pivotal.cfenv.test;

import java.io.InputStreamReader;
import java.io.Reader;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Scanner;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.After;

import org.springframework.boot.Banner;
import org.springframework.boot.WebApplicationType;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.Environment;
import org.springframework.util.CollectionUtils;

import io.pivotal.cfenv.core.CfEnvSingleton;
import io.pivotal.cfenv.core.UriInfo;
import io.pivotal.cfenv.core.test.CfEnvMock;

import static org.assertj.core.api.Assertions.assertThat;

/**
 * @author Mark Pollack
 * @author David Turanski
 */
public abstract class AbstractCfEnvTests {

	protected static final String hostname = "10.20.30.40";

	protected static final int port = 1234;

	protected static final String password = "mypass";

	protected static final String username = "myuser";

	private static ObjectMapper objectMapper = new ObjectMapper();

	@SuppressWarnings("unchecked")
	private static String getServiceLabel(String servicePayload) {
		try {
			Map serviceMap = objectMapper.readValue(servicePayload,
					Map.class);
			return serviceMap.get("label").toString();
		}
		catch (Exception e) {
			return null;
		}
	}

	protected static String getServicesPayload(String... servicePayloads) {
		Map> labelPayloadMap = new HashMap>();

		for (String payload : servicePayloads) {
			String label = getServiceLabel(payload);

			List payloadsForLabel = labelPayloadMap.get(label);
			if (payloadsForLabel == null) {
				payloadsForLabel = new ArrayList();
				labelPayloadMap.put(label, payloadsForLabel);
			}
			payloadsForLabel.add(payload);
		}

		StringBuilder result = new StringBuilder("{\n");
		int labelSize = labelPayloadMap.size();
		int i = 0;

		for (Map.Entry> entry : labelPayloadMap.entrySet()) {
			result.append(quote(entry.getKey())).append(":");
			result.append(getServicePayload(entry.getValue()));
			if (i++ != labelSize - 1) {
				result.append(",\n");
			}
		}
		result.append("}");

		return result.toString();

	}

	private static String getServicePayload(List servicePayloads) {
		StringBuilder payload = new StringBuilder("[");

		// In Scala, this would have been servicePayloads mkString "," :-)
		for (int i = 0; i < servicePayloads.size(); i++) {
			payload.append(servicePayloads.get(i));
			if (i != servicePayloads.size() - 1) {
				payload.append(",");
			}
		}
		payload.append("]");

		return payload.toString();
	}

	private static String quote(String str) {
		return "\"" + str + "\"";
	}

	protected CfEnvMock mockVcapServices(String vcapServicesJson) {
		return CfEnvMock.configure().vcapServices(vcapServicesJson).mock();
	}

	@After
	public void after() throws Exception {
		Field field = CfEnvSingleton.class.getDeclaredField("INSTANCE");
		field.setAccessible(true);
		field.set(null,null);
	}


	protected String getTemplatedPayload(String templateFile, String serviceName,
			String hostname, int port, String user, String password, String name) {
		String payload = readTestDataFile(templateFile);
		payload = payload.replace("$serviceName", serviceName);
		payload = payload.replace("$hostname", hostname);
		payload = payload.replace("$port", Integer.toString(port));
		payload = payload.replace("$user", UriInfo.urlEncode(user));
		payload = payload.replace("$password", UriInfo.urlEncode(password));
		payload = payload.replace("$name", name);

		return payload;
	}

	public Environment getEnvironment() {
		return getEnvironment(null);
	}

	public Environment getEnvironment(Map properties) {
		SpringApplicationBuilder builder = new SpringApplicationBuilder(TestApp.class)
			.web(WebApplicationType.NONE);
		if (!CollectionUtils.isEmpty(properties)) {
			builder.properties(properties);
		}
		builder.bannerMode(Banner.Mode.OFF);
		ConfigurableApplicationContext applicationContext = builder.run();
		Environment environment = applicationContext.getEnvironment();
		applicationContext.close();
		return environment;
	}

	protected String readTestDataFile(String fileName) {
		Scanner scanner = null;
		try {
			Reader fileReader = new InputStreamReader(
					getClass().getResourceAsStream(fileName));
			scanner = new Scanner(fileReader);
			return scanner.useDelimiter("\\Z").next();
		}
		finally {
			if (scanner != null) {
				scanner.close();
			}
		}
	}

	protected String getUserProvidedServicePayload(String serviceName, String hostname, int port,
												   String user, String password, String name, String scheme) {
		String payload = getTemplatedPayload("/test-ups-info.json", serviceName,
				hostname, port, user, password, name);
		return payload.replace("$scheme", scheme);
	}

	protected String getUserProvidedServicePayloadWithNoUri(String serviceName, String hostname, int port,
															String user, String password, String name) {
		return getTemplatedPayload("/test-ups-info-no-uri.json", serviceName,
				hostname, port, user, password, name);
	}

	protected void assertUriInfo(UriInfo uriInfo, String scheme, String instanceName) {
		assertThat(uriInfo.getScheme()).isEqualTo(scheme);
		assertThat(uriInfo.getPath()).isEqualTo(instanceName);
		assertCommonUriFields(uriInfo);
	}

	protected void assertUriInfo(UriInfo uriInfo, String scheme, String instanceName, String uname, String pwd) {
		assertThat(uriInfo.getScheme()).isEqualTo(scheme);
		assertThat(uriInfo.getPath()).isEqualTo(instanceName);
		assertHostPort(uriInfo);
		assertThat(uriInfo.getUsername()).isEqualTo(uname);
		assertThat(uriInfo.getPassword()).isEqualTo(pwd);
	}

	private void assertCommonUriFields(UriInfo uriInfo) {
		assertHostPort(uriInfo);
		assertThat(uriInfo.getUsername()).isEqualTo(username);
		assertThat(uriInfo.getPassword()).isEqualTo(password);
	}

	private void assertHostPort(UriInfo uriInfo) {
		assertThat(uriInfo.getHost()).isEqualTo(hostname);
		assertThat(uriInfo.getPort()).isEqualTo(port);
	}

	@SpringBootApplication
	static class TestApp {
	}

}