Add an abstract, base security context integration test class encapsulating functionality and configuration common to both local and cloud-based security integration tests.

geode-spring-boot-starter/src/test/java/org/springframework/boot/data/geode/security/auth/AbstractAutoConfiguredSecurityContextIntegrationTests.java

@@ -0,0 +1,180 @@
+/*
+ * Copyright 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
+ *
+ *     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 org.springframework.boot.data.geode.security.auth;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.data.gemfire.config.annotation.support.AutoConfiguredAuthenticationInitializer.SECURITY_PASSWORD_PROPERTY;
+import static org.springframework.data.gemfire.config.annotation.support.AutoConfiguredAuthenticationInitializer.SECURITY_USERNAME_PROPERTY;
+import static org.springframework.data.gemfire.util.RuntimeExceptionFactory.newIllegalArgumentException;
+
+import java.io.IOException;
+import java.io.Serializable;
+import java.security.Principal;
+import java.util.Optional;
+import java.util.Properties;
+
+import org.apache.geode.cache.GemFireCache;
+import org.apache.geode.cache.client.ClientRegionShortcut;
+import org.apache.geode.security.AuthenticationFailedException;
+import org.apache.geode.security.ResourcePermission;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.data.gemfire.GemfireTemplate;
+import org.springframework.data.gemfire.PartitionedRegionFactoryBean;
+import org.springframework.data.gemfire.client.ClientRegionFactoryBean;
+import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport;
+import org.springframework.util.StringUtils;
+
+import example.geode.cache.EchoCacheLoader;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
+/**
+ * The {@link AbstractAutoConfiguredSecurityContextIntegrationTests} class is an abstract security context integration test class
+ * encapsulating configuration and functionality common to both cloud and local security context integration tests.
+ *
+ * @author John Blum
+ * @see java.security.Principal
+ * @see org.apache.geode.cache.GemFireCache
+ * @see org.springframework.data.gemfire.GemfireTemplate
+ * @see org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport
+ * @since 1.0.0
+ */
+@SuppressWarnings("unused")
+public abstract class AbstractAutoConfiguredSecurityContextIntegrationTests
+		extends ForkingClientServerIntegrationTestsSupport {
+
+	protected static String applicationProperties = "Not Set";
+	protected static String securityContextUsername = "Not Set";
+	protected static String securityContextPassword = "Not Set";
+
+	@Autowired
+	private GemfireTemplate echoTemplate;
+
+	@Test
+	public void clientServerAuthWasSuccessful() {
+
+		assertThat(this.echoTemplate.<String, String>get("Hello")).isEqualTo("Hello");
+		assertThat(this.echoTemplate.<String, String>get("Test")).isEqualTo("Test");
+		assertThat(this.echoTemplate.<String, String>get("Good-Bye")).isEqualTo("Good-Bye");
+	}
+
+	protected static abstract class BaseGemFireClientConfiguration {
+
+		@Bean("Echo")
+		public ClientRegionFactoryBean<String, String> echoRegion(GemFireCache gemfireCache) {
+
+			ClientRegionFactoryBean<String, String> echoRegion = new ClientRegionFactoryBean<>();
+
+			echoRegion.setCache(gemfireCache);
+			echoRegion.setClose(false);
+			echoRegion.setShortcut(ClientRegionShortcut.PROXY);
+
+			return echoRegion;
+		}
+
+		@Bean
+		GemfireTemplate echoTemplate(GemFireCache gemfireCache) {
+			return new GemfireTemplate(gemfireCache.getRegion("/Echo"));
+		}
+	}
+
+	protected static abstract class BaseGemFireServerConfiguration {
+
+		@Bean("Echo")
+		public PartitionedRegionFactoryBean<String, String> echoRegion(GemFireCache gemfireCache) {
+
+			PartitionedRegionFactoryBean<String, String> echoRegion = new PartitionedRegionFactoryBean<>();
+
+			echoRegion.setCache(gemfireCache);
+			echoRegion.setCacheLoader(EchoCacheLoader.INSTANCE);
+			echoRegion.setClose(false);
+			echoRegion.setPersistent(false);
+
+			return echoRegion;
+		}
+	}
+
+	public static class TestSecurityManager implements org.apache.geode.security.SecurityManager {
+
+		private final String username;
+		private final String password;
+
+		public TestSecurityManager() throws IOException {
+
+			Properties securityProperties = new Properties();
+
+			securityProperties.load(new ClassPathResource(applicationProperties).getInputStream());
+
+			this.username = Optional.ofNullable(securityProperties.getProperty(securityContextUsername))
+				.filter(StringUtils::hasText)
+				.orElseThrow(() -> newIllegalArgumentException("Username is required"));
+
+			this.password = Optional.ofNullable(securityProperties.getProperty(securityContextPassword))
+				.filter(StringUtils::hasText)
+				.orElseThrow(() -> newIllegalArgumentException("Password is required"));
+		}
+
+		String getUsername() {
+			return username;
+		}
+
+		String getPassword() {
+			return password;
+		}
+
+		@Override
+		public Object authenticate(Properties credentials) throws AuthenticationFailedException {
+
+			String username = credentials.getProperty(SECURITY_USERNAME_PROPERTY);
+			String password = credentials.getProperty(SECURITY_PASSWORD_PROPERTY);
+
+			if (!(getUsername().equals(username) && getPassword().equals(password))) {
+				throw new AuthenticationFailedException(String.format("Failed to authenticate user [%s]", username));
+			}
+
+			return User.with(username).having(password);
+		}
+
+		@Override
+		public boolean authorize(Object principal, ResourcePermission permission) {
+			return true;
+		}
+	}
+
+	@Data
+	@ToString(of = "name")
+	@EqualsAndHashCode(of = "name")
+	@RequiredArgsConstructor(staticName = "with")
+	protected static class User implements Principal, Serializable {
+
+		@NonNull
+		private String name;
+
+		private String password;
+
+		public User having(String password) {
+			setPassword(password);
+			return this;
+		}
+	}
+}