Polish "Add test slice for Spring Data Cassandra"

See gh-17490

Author: snicoll

spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

@@ -6947,6 +6947,34 @@ TIP: Sometimes writing Spring WebFlux tests is not enough; Spring Boot can help
 
 
 
+[[boot-features-testing-spring-boot-applications-testing-autoconfigured-cassandra-test]]
+==== Auto-configured Data Cassandra Tests
+You can use `@DataCassandraTest` to test Cassandra applications.
+By default, it configures a `CassandraTemplate`, scans for `@Table` classes, and configures Spring Data Cassandra repositories.
+Regular `@Component` beans are not loaded into the `ApplicationContext`.
+(For more about using Cassandra with Spring Boot, see "<<boot-features-cassandra>>", earlier in this chapter.)
+
+TIP: A list of the auto-configuration settings that are enabled by `@DataCassandraTest` can be <<appendix-test-auto-configuration.adoc#test-auto-configuration,found in the appendix>>.
+
+The following example shows a typical setup for using Cassandra tests in Spring Boot:
+
+[source,java,indent=0]
+----
+	import org.springframework.beans.factory.annotation.Autowired;
+	import org.springframework.boot.test.autoconfigure.data.cassandra.DataCassandraTest;
+
+	@DataCassandraTest
+	class ExampleDataCassandraTests {
+
+		@Autowired
+		private YourRepository repository;
+
+		//
+	}
+----
+
+
+
 [[boot-features-testing-spring-boot-applications-testing-autoconfigured-jpa-test]]
 ==== Auto-configured Data JPA Tests
 You can use the `@DataJpaTest` annotation to test JPA applications.

spring-boot-project/spring-boot-test-autoconfigure/build.gradle

@@ -30,6 +30,7 @@ dependencies {
 	optional("org.springframework:spring-web")
 	optional("org.springframework:spring-webmvc")
 	optional("org.springframework:spring-webflux")
+	optional("org.springframework.data:spring-data-cassandra")
 	optional("org.springframework.data:spring-data-jdbc")
 	optional("org.springframework.data:spring-data-jpa")
 	optional("org.springframework.data:spring-data-ldap")
@@ -78,6 +79,7 @@ dependencies {
 	testImplementation("org.skyscreamer:jsonassert")
 	testImplementation("org.springframework.hateoas:spring-hateoas")
 	testImplementation("org.springframework.plugin:spring-plugin-core")
+	testImplementation("org.testcontainers:cassandra")
 	testImplementation("org.testcontainers:junit-jupiter")
 	testImplementation("org.testcontainers:neo4j")
 	testImplementation("org.testcontainers:testcontainers")

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/data/cassandra/AutoConfigureDataCassandra.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -27,11 +27,11 @@
 
 /**
  * {@link ImportAutoConfiguration Auto-configuration imports} for typical Data Cassandra
- * tests. Most tests should consider using {@link DataCassandraTest} rather than using
- * this annotation directly.
+ * tests. Most tests should consider using {@link DataCassandraTest @DataCassandraTest}
+ * rather than using this annotation directly.
  *
  * @author Artsiom Yudovin
- * @since 2.1.0
+ * @since 2.4.0
  * @see DataCassandraTest
  */
 @Target(ElementType.TYPE)

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/data/cassandra/DataCassandraTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -30,25 +30,25 @@
 import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration;
 import org.springframework.boot.test.autoconfigure.core.AutoConfigureCache;
 import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters;
-import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.ComponentScan.Filter;
 import org.springframework.core.annotation.AliasFor;
 import org.springframework.core.env.Environment;
 import org.springframework.test.context.BootstrapWith;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 
 /**
- * Annotation that can be used in combination with {@code @RunWith(SpringRunner.class)}
- * for a typical Cassandra test. Can be used when a test focuses <strong>only</strong> on
+ * Annotation that can be used for a Cassandra test that focuses <strong>only</strong> on
  * Cassandra components.
  * <p>
  * Using this annotation will disable full auto-configuration and instead apply only
  * configuration relevant to Cassandra tests.
  * <p>
- * By default, tests annotated with {@code @DataCassandraTest} will use an embedded
- * in-memory Cassandra process (if available).
+ * When using JUnit 4, this annotation should be used in combination with
+ * {@code @RunWith(SpringRunner.class)}.
  *
  * @author Artsiom Yudovin
- * @since 2.1.0
+ * @author Stephane Nicoll
+ * @since 2.4.0
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
@@ -86,14 +86,14 @@
 	 * application context.
 	 * @return include filters to apply
 	 */
-	ComponentScan.Filter[] includeFilters() default {};
+	Filter[] includeFilters() default {};
 
 	/**
 	 * A set of exclude filters which can be used to filter beans that would otherwise be
 	 * added to the application context.
 	 * @return exclude filters to apply
 	 */
-	ComponentScan.Filter[] excludeFilters() default {};
+	Filter[] excludeFilters() default {};
 
 	/**
 	 * Auto-configuration exclusions that should be applied for this test.

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/data/cassandra/DataCassandraTestContextBootstrapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -18,21 +18,21 @@
 
 import org.springframework.boot.test.context.SpringBootTestContextBootstrapper;
 import org.springframework.core.annotation.MergedAnnotations;
+import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.TestContextBootstrapper;
 
 /**
  * {@link TestContextBootstrapper} for {@link DataCassandraTest @DataCassandraTest}
  * support.
  *
  * @author Artsiom Yudovin
- * @since 2.1.0
  */
-public class DataCassandraTestContextBootstrapper extends SpringBootTestContextBootstrapper {
+class DataCassandraTestContextBootstrapper extends SpringBootTestContextBootstrapper {
 
 	@Override
 	protected String[] getProperties(Class<?> testClass) {
-		return MergedAnnotations.from(testClass, MergedAnnotations.SearchStrategy.INHERITED_ANNOTATIONS)
-				.get(DataCassandraTest.class).getValue("properties", String[].class).orElse(null);
+		return MergedAnnotations.from(testClass, SearchStrategy.INHERITED_ANNOTATIONS).get(DataCassandraTest.class)
+				.getValue("properties", String[].class).orElse(null);
 	}
 
 }

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/data/cassandra/DataCassandraTypeExcludeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -23,9 +23,8 @@
  * {@link TypeExcludeFilter} for {@link DataCassandraTest @DataCassandraTest}.
  *
  * @author Artsiom Yudovin
- * @since 2.1.0
  */
-public class DataCassandraTypeExcludeFilter extends StandardAnnotationCustomizableTypeExcludeFilter<DataCassandraTest> {
+class DataCassandraTypeExcludeFilter extends StandardAnnotationCustomizableTypeExcludeFilter<DataCassandraTest> {
 
 	protected DataCassandraTypeExcludeFilter(Class<?> testClass) {
 		super(testClass);

spring-boot-project/spring-boot-test-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -6,6 +6,8 @@ org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
 org.springframework.boot.test.autoconfigure.data.cassandra.AutoConfigureDataCassandra=\
 org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
 org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
+org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
+org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
 org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration
 
 # AutoConfigureDataJdbc auto-configuration imports

spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/actuate/metrics/AutoConfigureMetricsSpringBootApplication.java

@@ -19,6 +19,7 @@
 import org.springframework.boot.SpringBootConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration;
 
 /**
  * Example {@link SpringBootApplication @SpringBootApplication} for use with
@@ -27,7 +28,7 @@
  * @author Chris Bono
  */
 @SpringBootConfiguration
-@EnableAutoConfiguration
+@EnableAutoConfiguration(exclude = CassandraAutoConfiguration.class)
 class AutoConfigureMetricsSpringBootApplication {
 
 }

spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/data/cassandra/DataCassandraTestIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -16,23 +16,25 @@
 
 package org.springframework.boot.test.autoconfigure.data.cassandra;
 
+import java.time.Duration;
 import java.util.UUID;
 
-import com.datastax.driver.core.Cluster;
+import com.datastax.oss.driver.api.core.CqlSession;
+import com.datastax.oss.driver.api.core.CqlSessionBuilder;
 import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.CassandraContainer;
 import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
 
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.data.redis.ExampleService;
-import org.springframework.boot.test.util.TestPropertyValues;
-import org.springframework.boot.testsupport.testcontainers.CassandraContainer;
-import org.springframework.boot.testsupport.testcontainers.DisabledWithoutDockerTestcontainers;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextInitializer;
-import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Bean;
 import org.springframework.data.cassandra.core.CassandraTemplate;
-import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
@@ -42,13 +44,21 @@
  *
  * @author Artsiom Yudovin
  */
-@DisabledWithoutDockerTestcontainers
-@ContextConfiguration(initializers = DataCassandraTestIntegrationTests.Initializer.class)
-@DataCassandraTest
+@DataCassandraTest(properties = { "spring.data.cassandra.local-datacenter=datacenter1",
+		"spring.data.cassandra.schema-action=create-if-not-exists",
+		"spring.data.cassandra.connection.connect-timeout=10s", "spring.data.cassandra.request.timeout=5s" })
+@Testcontainers(disabledWithoutDocker = true)
 class DataCassandraTestIntegrationTests {
 
 	@Container
-	public static CassandraContainer cassandra = new CassandraContainer();
+	static final CassandraContainer<?> cassandra = new CassandraContainer<>().withStartupAttempts(5)
+			.withStartupTimeout(Duration.ofMinutes(10));
+
+	@DynamicPropertySource
+	static void cassandraProperties(DynamicPropertyRegistry registry) {
+		registry.add("spring.data.cassandra.contact-points",
+				() -> cassandra.getHost() + ":" + cassandra.getFirstMappedPort());
+	}
 
 	@Autowired
 	private CassandraTemplate cassandraTemplate;
@@ -67,36 +77,28 @@ void didNotInjectExampleService() {
 
 	@Test
 	void testRepository() {
-
-		Person person = new Person();
-		person.setDescription("Look, new @DataCassandraTest!");
+		ExampleEntity entity = new ExampleEntity();
+		entity.setDescription("Look, new @DataCassandraTest!");
 		String id = UUID.randomUUID().toString();
-		person.setId(id);
-
-		Person savedEntity = this.exampleRepository.save(person);
-		Person getEntity = this.cassandraTemplate.selectOneById(id, Person.class);
-
+		entity.setId(id);
+		ExampleEntity savedEntity = this.exampleRepository.save(entity);
+		ExampleEntity getEntity = this.cassandraTemplate.selectOneById(id, ExampleEntity.class);
 		assertThat(getEntity).isNotNull();
 		assertThat(getEntity.getId()).isNotNull();
 		assertThat(getEntity.getId()).isEqualTo(savedEntity.getId());
-
 		this.exampleRepository.deleteAll();
 	}
 
-	static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
-
-		@Override
-		public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
-			TestPropertyValues.of("spring.data.cassandra.port=" + cassandra.getFirstMappedPort())
-					.and("spring.data.cassandra.keyspaceName=test")
-					.and("spring.data.cassandra.schema-action=CREATE_IF_NOT_EXISTS")
-					.applyTo(configurableApplicationContext.getEnvironment());
+	@TestConfiguration(proxyBeanMethods = false)
+	static class KeyspaceTestConfiguration {
 
-			Cluster cluster = Cluster.builder().withoutJMXReporting()
-					.addContactPoints(cassandra.getContainerIpAddress()).withPort(cassandra.getFirstMappedPort())
-					.build();
-			cluster.connect().execute("CREATE KEYSPACE test "
-					+ "WITH replication = {'class':'SimpleStrategy', 'replication_factor' : 1};");
+		@Bean
+		CqlSession cqlSession(CqlSessionBuilder cqlSessionBuilder) {
+			try (CqlSession session = cqlSessionBuilder.build()) {
+				session.execute("CREATE KEYSPACE IF NOT EXISTS boot_test"
+						+ "  WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };");
+			}
+			return cqlSessionBuilder.withKeyspace("boot_test").build();
 		}
 
 	}

spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/data/cassandra/DataCassandraTestPropertiesIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -16,34 +16,29 @@
 
 package org.springframework.boot.test.autoconfigure.data.cassandra;
 
+import com.datastax.oss.driver.api.core.CqlSession;
+import com.datastax.oss.driver.api.core.context.DriverContext;
+import com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry;
 import org.junit.jupiter.api.Test;
-import org.testcontainers.junit.jupiter.Container;
 
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.util.TestPropertyValues;
-import org.springframework.boot.testsupport.testcontainers.CassandraContainer;
-import org.springframework.boot.testsupport.testcontainers.DisabledWithoutDockerTestcontainers;
-import org.springframework.context.ApplicationContextInitializer;
-import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
 import org.springframework.core.env.Environment;
-import org.springframework.test.context.ContextConfiguration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for the {@link DataCassandraTest#properties properties} attribute of
  * {@link DataCassandraTest @DataCassandraTest}.
  *
  * @author Artsiom Yudovin
  */
-@DisabledWithoutDockerTestcontainers
-@ContextConfiguration(initializers = DataCassandraTestPropertiesIntegrationTests.Initializer.class)
 @DataCassandraTest(properties = "spring.profiles.active=test")
 class DataCassandraTestPropertiesIntegrationTests {
 
-	@Container
-	public static final CassandraContainer cassandra = new CassandraContainer();
-
 	@Autowired
 	private Environment environment;
 
@@ -52,12 +47,17 @@ void environmentWithNewProfile() {
 		assertThat(this.environment.getActiveProfiles()).containsExactly("test");
 	}
 
-	static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+	@TestConfiguration(proxyBeanMethods = false)
+	static class CassandraMockConfiguration {
 
-		@Override
-		public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
-			TestPropertyValues.of("spring.data.cassandra.port=" + cassandra.getFirstMappedPort())
-					.applyTo(configurableApplicationContext.getEnvironment());
+		@Bean
+		CqlSession cqlSession() {
+			DriverContext context = mock(DriverContext.class);
+			CodecRegistry codecRegistry = mock(CodecRegistry.class);
+			given(context.getCodecRegistry()).willReturn(codecRegistry);
+			CqlSession cqlSession = mock(CqlSession.class);
+			given(cqlSession.getContext()).willReturn(context);
+			return cqlSession;
 		}
 
 	}