feat(all): add rule/extension to delete data from ES index

Author: tinesoft

README.md

@@ -2,15 +2,15 @@
 # spring-esdata-loader
 [![Build  Status](https://travis-ci.org/tinesoft/spring-esdata-loader.svg?branch=master)](https://travis-ci.org/tinesoft/spring-esdata-loader)
 
-`spring-esdata-loader` is a Java testing library to help you write integration tests for your [spring-data elasticsearch](https://spring.io/projects/spring-data-elasticsearch)-based projects, by allowing you to easily load data into Elasticsearch, using entity mappings (i.e domain classes annotated with `@Document`, `@Field`, etc) and via a specific **Junit 4**'s Rule or **JUnit Jupiter**'s Extension.
+`spring-esdata-loader` is a Java testing library to help you write integration tests for your [spring-data elasticsearch](https://spring.io/projects/spring-data-elasticsearch)-based projects, by allowing you to easily load data into Elasticsearch, using entity mappings (i.e domain classes annotated with `@Document`, `@Field`, etc) and via specific **Junit 4**'s Rules or **JUnit Jupiter**'s Extensions.
 
 The library reads all the metadata it needs from the entity classes (index name, index type, etc) , uses them to create/refresh the index on the ES server and feeds it with the data using the `ElasticsearchTemplate` present in your test application context.
 
 ## Features
 
 * **Simple API** and no configuration required
-* Support  for  **JUnit 4** via `LoadEsDataRule`
-* Support  for  **JUnit  Jupiter** via `@LoadEsDataConfig` or `@LoadEsDataExtension`
+* Support  for  **JUnit 4** via `LoadEsDataRule`, `DeleteEsDataRule`
+* Support  for  **JUnit  Jupiter** via `@LoadEsDataConfig` / `@LoadEsDataExtension` or `@DeleteEsDataConfig` / `@DeleteEsDataExtension`
 * Built-in support for **gzipped data**
 * Written  in  **Java  8**
 * Based on **Spring (Data, Test)**
@@ -43,14 +43,14 @@ To get started,
         <td>JUnit 4</td>
         <td>
 <pre lang="groovy">dependencies {
-    testImplementation 'com.github.spring-esdata-loader:spring-esdata-loader-junit4:1.0.0'
+    testImplementation 'com.github.spring-esdata-loader:spring-esdata-loader-junit4:2.0.0'
 }</pre>
         </td>
         <td>
 <pre lang="xml">&lt;dependency&gt;
     &lt;groupId&gt;com.github.spring-esdata-loader&lt;/groupId&gt;
     &lt;artifactId>spring-esdata-loader-junit4&lt;/artifactId&gt;
-    &lt;version>1.0.0&lt;/version&gt;
+    &lt;version>2.0.0&lt;/version&gt;
     &lt;scope>test&lt;/scope&gt;
 &lt;/dependency&gt;</pre>
         </td>
@@ -59,14 +59,14 @@ To get started,
         <td>JUnit Jupiter</td>
         <td>
 <pre lang="groovy">dependencies {
-    testImplementation 'com.github.spring-esdata-loader:spring-esdata-loader-junit-jupiter:1.0.0'
+    testImplementation 'com.github.spring-esdata-loader:spring-esdata-loader-junit-jupiter:2.0.0'
 }</pre>
         </td>
         <td>
 <pre lang="xml">&lt;dependency&gt;
     &lt;groupId&gt;com.github.spring-esdata-loader&lt;/groupId&gt;
     &lt;artifactId>spring-esdata-loader-junit-jupiter&lt;/artifactId&gt;
-    &lt;version>1.0.0&lt;/version&gt;
+    &lt;version>2.0.0&lt;/version&gt;
     &lt;scope>test&lt;/scope&gt;
 &lt;/dependency&gt;</pre>
         </td>

build.gradle

@@ -14,7 +14,7 @@ buildscript {
       classpath "org.ajoberstar:gradle-git-publish:2.1.1"
     }
 }
-description = "Set of JUnit Rule & Extension to easily load data to test your spring-data elasticsearch-based projects"
+description = "Set of JUnit Rules & Extensions to easily load data to test your spring-data elasticsearch-based projects"
 
 allprojects {
   apply plugin: "nebula.release"

core/src/main/java/com/github/spring/esdata/loader/core/DeleteEsData.java

@@ -0,0 +1,33 @@
+package com.github.spring.esdata.loader.core;
+
+import org.springframework.core.annotation.AliasFor;
+
+import java.lang.annotation.*;
+
+/**
+ * {@code @LoadEsData} is a {@linkplain Repeatable repeatable} annotation
+ * that is used to define which data to delete from Elasticsearch index.
+ *
+ * @author tinesoft
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.METHOD, ElementType.TYPE})
+public @interface DeleteEsData {
+  /**
+   * Alias for {@link DeleteEsData#value}.
+   *
+   * @return mapping classes of the data to be deleted from Elasticsearch
+   */
+  @AliasFor("value")
+  Class<?>[] esEntityClasses() default {};
+
+
+  /**
+   * Alias for {@link DeleteEsData#esEntityClasses}.
+   *
+   * @return mapping classes of the data to be deleted from Elasticsearch
+   */
+  @AliasFor("esEntityClasses")
+  Class<?>[] value() default {};
+
+}

core/src/main/java/com/github/spring/esdata/loader/core/EsDataLoader.java

@@ -0,0 +1,7 @@
+package com.github.spring.esdata.loader.core;
+
+public interface EsDataLoader {
+  void delete(Class<?> esEntityClass);
+
+  void load(IndexData d);
+}

core/src/main/java/com/github/spring/esdata/loader/core/SpringEsDataLoader.java

@@ -22,7 +22,7 @@
  * @author tinesoft
  *
  */
-public class SpringEsDataLoader {
+public class SpringEsDataLoader implements EsDataLoader {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(SpringEsDataLoader.class);
 	private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
@@ -38,14 +38,30 @@ public SpringEsDataLoader(final ElasticsearchTemplate esTemplate) {
 		this.esTemplate = esTemplate;
 	}
 
-    /**
-     * Loads given data into ElasticSearch. Target indices are dropped and recreated before data are inserted in bulk.
-	 * @param d the data to load
+  /**
+   * Deletes data from Elasticsearch using provided class to retrieve related index.
+   *
+   * @param esEntityClass the data to load
+   */
+  @Override
+  public void delete(Class<?> esEntityClass) {
+    LOGGER.debug("Dropping data in Index '{}'...", esEntityClass.getSimpleName());
+    this.esTemplate.deleteIndex(esEntityClass);
+    this.esTemplate.createIndex(esEntityClass);
+    this.esTemplate.putMapping(esEntityClass);
+    this.esTemplate.refresh(esEntityClass);
+
+  }
+
+  /**
+   * Loads given data into Elasticsearch. Target indices are dropped and recreated before data are inserted in bulk.
+   * @param d the data to load
      */
-	public void load(final IndexData d) {
+  @Override
+  public void load(final IndexData d) {
 
 		// first recreate the index
-		LOGGER.info("Recreating Index for '{}'...", d.getEsEntityClass().getSimpleName());
+    LOGGER.debug("Recreating Index for '{}'...", d.getEsEntityClass().getSimpleName());
 		this.esTemplate.deleteIndex(d.esEntityClass);
 		this.esTemplate.createIndex(d.esEntityClass);
 		this.esTemplate.putMapping(d.esEntityClass);

core/src/main/java/com/github/spring/esdata/loader/core/SpringUtils.java

@@ -6,7 +6,6 @@
 import org.springframework.data.elasticsearch.core.ElasticsearchTemplate;
 
 import java.util.Map;
-import java.util.function.Consumer;
 
 /**
  * Utility class to interact with Spring.
@@ -44,12 +43,13 @@ public static <T> T getBeanOfType(ApplicationContext applicationContext, final C
 		return null;
 	}
 
-    /**
-     * Retrieve a {@link ElasticsearchTemplate} from the {@link ApplicationContext} and creates a data loader from it.
-	 * @param appContext the Spring {@link ApplicationContext}
-	 * @return a {@link Consumer} that accepts one or more {@link IndexData} objects and inserts them in the underlying ES Server.
-     */
-	public static Consumer<IndexData> getDataLoader(final ApplicationContext appContext) {
+  /**
+   * Retrieve a {@link ElasticsearchTemplate} from the {@link ApplicationContext} and creates a {@link EsDataLoader} from it.
+   *
+   * @param appContext the Spring {@link ApplicationContext}
+   * @return a {@link EsDataLoader} that can insert or remove data from the underlying ES Server.
+   */
+  public static EsDataLoader getDataLoader(final ApplicationContext appContext) {
 
 		if (appContext == null) {
 			LOGGER.error(
@@ -63,9 +63,9 @@ public static Consumer<IndexData> getDataLoader(final ApplicationContext appCont
 			LOGGER.error("No Spring's bean of type 'ElasticsearchTemplate' was found!");
 			throw new IllegalStateException(
 					"Missing bean of type 'ElasticsearchTemplate' in your Spring configuration");
-		}
+    }
 
-		return new SpringEsDataLoader(esTemplate)::load;
+    return new SpringEsDataLoader(esTemplate);
 	}
 
 }

demo/build.gradle

@@ -10,7 +10,7 @@ ext["junit-jupiter.version"] = "5.5.0"
 dependencies {
 
 	implementation 'org.springframework.boot:spring-boot-starter-data-elasticsearch'
-	
+
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 
 	testImplementation 'org.testcontainers:elasticsearch:1.11.3'
@@ -34,4 +34,5 @@ test {
 	testLogging {
 		events 'PASSED', 'FAILED', 'SKIPPED'
 	}
-}
+
+}

demo/src/main/java/com/github/spring/esdata/loader/demo/model/BookEsEntity.java

@@ -33,31 +33,31 @@ public BookEsEntity(String id, String isbn, String title, AuthorEsEntity author)
 	}
 
 	public String getId() {
-		return id;
+		return this.id;
 	}
 
 	public void setId(String id) {
 		this.id = id;
 	}
 
 	public String getIsbn() {
-		return isbn;
+		return this.isbn;
 	}
 
 	public void setIsbn(final String isbn) {
 		this.isbn = isbn;
 	}
 
 	public String getTitle() {
-		return title;
+		return this.title;
 	}
 
 	public void setTitle(final String title) {
 		this.title = title;
 	}
 
 	public AuthorEsEntity getAuthor() {
-		return author;
+		return this.author;
 	}
 
 	public void setAuthor(final AuthorEsEntity author) {
@@ -67,13 +67,13 @@ public void setAuthor(final AuthorEsEntity author) {
 	@Override
 	public boolean equals(Object o) {
 		if (this == o) return true;
-		if (o == null || getClass() != o.getClass()) return false;
-		BookEsEntity that = (BookEsEntity) o;
-		return id.equals(that.id);
+		if (o == null || this.getClass() != o.getClass()) return false;
+    BookEsEntity that = (BookEsEntity) o;
+		return this.id.equals(that.id);
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(id);
+		return Objects.hash(this.id);
 	}
 }

demo/src/test/java/com/github/spring/esdata/loader/demo/junit/jupiter/DeleteEsDataExtensionTest.java

@@ -0,0 +1,81 @@
+package com.github.spring.esdata.loader.demo.junit.jupiter;
+
+import com.github.spring.esdata.loader.core.DeleteEsData;
+import com.github.spring.esdata.loader.demo.DemoTestPropertyValues;
+import com.github.spring.esdata.loader.demo.model.AuthorEsEntity;
+import com.github.spring.esdata.loader.demo.model.BookEsEntity;
+import com.github.spring.esdata.loader.demo.model.LibraryEsEntity;
+import com.github.spring.esdata.loader.junit.jupiter.DeleteEsDataConfig;
+import org.junit.jupiter.api.MethodOrderer;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.MockReset;
+import org.springframework.boot.test.mock.mockito.SpyBean;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.data.elasticsearch.core.ElasticsearchTemplate;
+import org.springframework.test.context.ContextConfiguration;
+import org.testcontainers.elasticsearch.ElasticsearchContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+
+
+/**
+ * Simple integration test to illustrate how to use the library when testing with JUnit Jupiter.
+ *
+ * @author tinesoft
+ */
+
+// helper to easily start a dockerized Elasticsearch server to run our tests against (not required to use this library)
+@Testcontainers
+
+// The following annotation registers the @DeleteEsDataExtention with JUnit Jupiter
+// and specifies which data to remove from the underlying Elasticsearch Server.
+// The data will be removed only once, before all tests (i.e in the beforeAll() phase)
+@DeleteEsDataConfig({AuthorEsEntity.class, BookEsEntity.class})
+@SpringBootTest
+
+//for this test setup only, not required in general
+@ContextConfiguration(initializers = DeleteEsDataExtensionTest.ExposedDockerizedEsConfiguration.class)
+
+@TestMethodOrder(MethodOrderer.Alphanumeric.class)// because of the @SpyBean below, we need to control test order
+public class DeleteEsDataExtensionTest {
+
+  @Container
+  // helper to easily start a dockerized Elasticsearch server to run our tests against (not required to use this library)
+  public static final ElasticsearchContainer ES_CONTAINER = new ElasticsearchContainer(DemoTestPropertyValues.ES_DOCKER_IMAGE_VERSION);
+
+  @SpyBean(reset = MockReset.NONE)
+  private ElasticsearchTemplate esMockTemplate;
+
+  @Test
+  public void dataDeletedAtClassLevel() {
+
+    verify(this.esMockTemplate).deleteIndex(AuthorEsEntity.class);
+    verify(this.esMockTemplate).deleteIndex(BookEsEntity.class);
+    verify(this.esMockTemplate, never()).deleteIndex(LibraryEsEntity.class);//removed at method level, see below #dataDeleteedAtMethodLevel()
+  }
+
+  @Test
+  // the following data will be removed for this test only
+  @DeleteEsData(esEntityClasses = {LibraryEsEntity.class})
+  public void dataDeletedAtMethodLevel() {
+
+    verify(this.esMockTemplate).deleteIndex(AuthorEsEntity.class);//removed at class level, before all tests
+    verify(this.esMockTemplate).deleteIndex(BookEsEntity.class);//removed at class level, before all tests
+    verify(this.esMockTemplate).deleteIndex(LibraryEsEntity.class);
+  }
+
+  public static class ExposedDockerizedEsConfiguration implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    @Override
+    public void initialize(ConfigurableApplicationContext cac) {
+      DemoTestPropertyValues.using(ES_CONTAINER).applyTo(cac.getEnvironment());
+    }
+  }
+
+}

demo/src/test/java/com/github/spring/esdata/loader/demo/junit/jupiter/LoadEsDataExtensionTest.java

@@ -38,14 +38,15 @@
 		@LoadEsData(esEntityClass = BookEsEntity.class, location = "/data/books.json.gz"), // built-in support for gzipped files
 })
 @SpringBootTest
-
-@ContextConfiguration(initializers = LoadEsDataExtensionTest.ExposeDockerizedElasticsearchServer.class)//for this test setup only, not required in general
+//for this test setup only, not required in general
+@ContextConfiguration(initializers = LoadEsDataExtensionTest.ExposedDockerizedEsConfiguration.class)
 public class LoadEsDataExtensionTest {
 
-	@Container // helper to easily start a dockerized Elasticsearch server to run our tests against (not required to use this library)
-	private static final ElasticsearchContainer ES_CONTAINER = new ElasticsearchContainer(DemoTestPropertyValues.ES_DOCKER_IMAGE_VERSION);
+  @Container
+  // helper to easily start a dockerized Elasticsearch server to run our tests against (not required to use this library)
+  public static final ElasticsearchContainer ES_CONTAINER = new ElasticsearchContainer(DemoTestPropertyValues.ES_DOCKER_IMAGE_VERSION);
 
-	@Autowired
+  @Autowired
 	private AuthorEsRepository esAuthorRepository;
 
 	@Autowired
@@ -80,12 +81,13 @@ public void dataLoadedAtMethodLevel() {
 		assertThat(libraries).hasSize(5);
 	}
 
-	static class ExposeDockerizedElasticsearchServer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+  public static class ExposedDockerizedEsConfiguration implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+
+    @Override
+    public void initialize(ConfigurableApplicationContext cac) {
+      DemoTestPropertyValues.using(ES_CONTAINER).applyTo(cac.getEnvironment());
+    }
+  }
 
-		@Override
-		public void initialize(ConfigurableApplicationContext cac) {
-			DemoTestPropertyValues.using(ES_CONTAINER).applyTo(cac.getEnvironment());
-		}
-	}
 }