Merge pull request #31 from niemannd/feat/integration-tests

split integration and unit tests

Author: eskombro

.github/workflows/gradle.yml

@@ -16,13 +16,13 @@ jobs:
 
         steps:
             -   uses: actions/checkout@v2
+            -   name: Docker setup
+                run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics=true --no-sentry=true --master-key='masterKey'
             -   name: Set up JDK 1.8
                 uses: actions/setup-java@v1
                 with:
                     java-version: 1.8
             -   name: Grant execute permission for gradlew
                 run: chmod +x gradlew
-            -   name: Docker setup
-                run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch  --no-analytics=true --master-key=masterKey
             -   name: Build with Gradle
-                run: ./gradlew build
+                run: ./gradlew build integrationTest

build.gradle

@@ -11,6 +11,14 @@ plugins {
 	id 'java-library'
 }
 
+group = 'com.meilisearch.sdk'
+version = '0.1.0-SNAPSHOT'
+
+java {
+	sourceCompatibility = JavaVersion.VERSION_1_8
+	targetCompatibility = JavaVersion.VERSION_1_8
+}
+
 repositories {
 	// Use jcenter for resolving dependencies.
 	// You can declare any Maven/Ivy/file repository here.
@@ -48,7 +56,18 @@ task buildJar(type: Jar) {
 }
 
 test {
-	useJUnitPlatform()
+	useJUnitPlatform {
+		excludeTags("integration")
+	}
+	testLogging {
+		events "passed", "skipped", "failed"
+	}
+}
+
+task integrationTest(type: Test) {
+	useJUnitPlatform {
+		includeTags("integration")
+	}
 	testLogging {
 		events "passed", "skipped", "failed"
 	}

src/main/java/com/meilisearch/sdk/SearchRequest.java

@@ -4,15 +4,15 @@
  * Search request query string builder
  */
 class SearchRequest {
-	String q;
-	int offset;
-	int limit;
-	String attributesToRetrieve;
-	String attributesToCrop;
-	int cropLength;
-	String attributesToHighlight;
-	String filters;
-	boolean matches;
+	private String q;
+	private int offset;
+	private int limit;
+	private String attributesToRetrieve;
+	private String attributesToCrop;
+	private int cropLength;
+	private String attributesToHighlight;
+	private String filters;
+	private boolean matches;
 
 	SearchRequest(String q) {
 		this(q, 0);
@@ -50,6 +50,42 @@ class SearchRequest {
 		this.matches = matches;
 	}
 
+	public String getQ() {
+		return q;
+	}
+
+	public int getOffset() {
+		return offset;
+	}
+
+	public int getLimit() {
+		return limit;
+	}
+
+	public String getAttributesToRetrieve() {
+		return attributesToRetrieve;
+	}
+
+	public String getAttributesToCrop() {
+		return attributesToCrop;
+	}
+
+	public int getCropLength() {
+		return cropLength;
+	}
+
+	public String getAttributesToHighlight() {
+		return attributesToHighlight;
+	}
+
+	public String getFilters() {
+		return filters;
+	}
+
+	public boolean isMatches() {
+		return matches;
+	}
+
 	String getQuery() {
 		StringBuilder sb = new StringBuilder();
 

src/test/java/com/meilisearch/integration/AbstractIT.java

@@ -0,0 +1,74 @@
+package com.meilisearch.integration;
+
+
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
+import com.meilisearch.sdk.Client;
+import com.meilisearch.sdk.Config;
+import com.meilisearch.sdk.Index;
+import com.meilisearch.sdk.utils.Movie;
+
+import java.io.*;
+import java.net.URL;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public abstract class AbstractIT {
+	protected Client client;
+	protected final Gson gson = new Gson();
+
+	private final Map<String, TestData<?>> testData = new HashMap<>();
+
+	public static final String MOVIES_INDEX = "movies.json";
+
+	public AbstractIT() {
+		try {
+			loadResource(MOVIES_INDEX);
+		} catch (IOException e) {
+			e.printStackTrace();
+		}
+	}
+
+	public void setUp() {
+		if (client == null)
+			client = new Client(new Config("http://localhost:7700", "masterKey"));
+	}
+
+
+	public static void cleanup() {
+		deleteAllIndexes();
+	}
+
+	public void loadResource(String fileName) throws IOException {
+		ClassLoader classLoader = getClass().getClassLoader();
+
+		URL resource = classLoader.getResource(fileName);
+		if (resource == null) {
+			throw new IllegalArgumentException("file is not found!");
+		}
+		File file = new File(resource.getFile());
+		String rawData = new BufferedReader(new InputStreamReader(new FileInputStream(file))).lines().collect(Collectors.joining());
+		List<Movie> movies = gson.fromJson(rawData, TypeToken.getParameterized(List.class, Movie.class).getType());
+		testData.put(fileName, new TestData<>(rawData, movies));
+	}
+
+	static public void deleteAllIndexes() {
+		try {
+			Client ms = new Client(new Config("http://localhost:7700", "masterKey"));
+			Index[] indexes = ms.getIndexList();
+			for (Index index : indexes) {
+				ms.deleteIndex(index.getUid());
+			}
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
+
+	@SuppressWarnings("unchecked")
+	public <T> TestData<T> getTestData(String index, Class<T> tClass) {
+		return (TestData<T>) testData.get(index);
+	}
+
+}

src/test/java/com/meilisearch/integration/DocumentsTest.java

@@ -0,0 +1,84 @@
+package com.meilisearch.integration;
+
+import com.meilisearch.sdk.Index;
+import com.meilisearch.sdk.UpdateStatus;
+import com.meilisearch.sdk.utils.Movie;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+@Tag("integration")
+public class DocumentsTest extends AbstractIT {
+
+	@BeforeEach
+	public void initialize() {
+		this.setUp();
+	}
+
+	@AfterAll
+	static void cleanMeiliSearch() {
+		cleanup();
+	}
+
+	/**
+	 * Test Add single document
+	 */
+	@Test
+	public void testAddDocumentsSingle() throws Exception {
+
+		String indexUid = "addSingleDocument";
+		client.createIndex(indexUid);
+		Index index = client.getIndex(indexUid);
+
+		TestData<Movie> testData = this.getTestData(MOVIES_INDEX, Movie.class);
+		String singleDocument = this.gson.toJson(testData.getData().get(0));
+		UpdateStatus updateInfo = this.gson.fromJson(
+			index.addDocuments("[" + singleDocument + "]"),
+			UpdateStatus.class
+		);
+
+		index.waitForPendingUpdate(updateInfo.getUpdateId());
+		Movie[] movies = this.gson.fromJson(index.getDocuments(), Movie[].class);
+
+		assertEquals(1, movies.length);
+		assertEquals(419704, movies[0].getId());
+		assertEquals("Ad Astra", movies[0].getTitle());
+		assertEquals("https://image.tmdb.org/t/p/original/xBHvZcjRiWyobQ9kxBhO6B2dtRI.jpg", movies[0].getPoster());
+		assertEquals("The near future, a time when both hope and hardships drive humanity to look to the stars and beyond. While a mysterious phenomenon menaces to destroy life on planet Earth, astronaut Roy McBride undertakes a mission across the immensity of space and its many perils to uncover the truth about a lost expedition that decades before boldly faced emptiness and silence in search of the unknown.", movies[0].getOverview());
+		assertEquals("2019-09-17", movies[0].getRelease_date());
+		assertEquals("en", movies[0].getLanguage());
+		assertNotNull(movies[0].getGenres());
+		assertEquals(2, movies[0].getGenres().length);
+		assertEquals("Science Fiction", movies[0].getGenres()[0]);
+		assertEquals("Drama", movies[0].getGenres()[1]);
+	}
+
+	/**
+	 * Test Add multiple documents
+	 */
+	@Test
+	public void testAddDocumentsMultiple() throws Exception {
+
+		String indexUid = "addMultipleDocuments";
+		client.createIndex(indexUid);
+		Index index = client.getIndex(indexUid);
+
+		TestData<Movie> testData = this.getTestData(MOVIES_INDEX, Movie.class);
+		UpdateStatus updateInfo = this.gson.fromJson(
+			index.addDocuments(testData.getRaw()),
+			UpdateStatus.class
+		);
+
+		index.waitForPendingUpdate(updateInfo.getUpdateId());
+		Movie[] movies = this.gson.fromJson(index.getDocuments(), Movie[].class);
+		for (int i = 0; i < movies.length; i++) {
+			assertEquals(movies[i].getTitle(), testData.getData().get(i).getTitle());
+		}
+	}
+
+}
+