Update tests to run with junit5 & add docker-compose for local testing

Author: snigdhasjg

docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+  typesense:
+    image: typesense/typesense:0.24.1
+    container_name: "typesense"
+    ports:
+      - "8108:8108"
+    volumes:
+      - data-dir:/data
+    environment:
+      TYPESENSE_DATA_DIR: /data
+      TYPESENSE_API_KEY: xyz
+    restart: "no"
+
+volumes:
+  data-dir:

src/test/java/org/typesense/api/AliasesTest.java

@@ -1,53 +1,54 @@
 package org.typesense.api;
 
-import junit.framework.TestCase;
-import org.typesense.api.exceptions.TypesenseError;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.typesense.model.CollectionAlias;
 import org.typesense.model.CollectionAliasSchema;
 import org.typesense.model.CollectionAliasesResponse;
-import org.typesense.resources.Node;
 
-import java.time.Duration;
-import java.util.ArrayList;
-
-public class AliasesTest extends TestCase {
+class AliasesTest {
 
     private Client client;
     private Helper helper;
 
-    public void setUp() throws Exception {
-        super.setUp();
+    @BeforeEach
+    void setUp() throws Exception {
         helper = new Helper();
         helper.teardown();
         client = helper.getClient();
         helper.createTestAlias();
     }
 
-    public void tearDown() throws Exception {
-        super.tearDown();
+    @AfterEach
+    void tearDown() throws Exception {
         helper.teardown();
     }
 
-    public void testUpsert() throws Exception {
+    @Test
+    void testUpsert() throws Exception {
         CollectionAliasSchema collectionAliasSchema = new CollectionAliasSchema();
         collectionAliasSchema.collectionName("books_june11");
 
         System.out.println(client.aliases().upsert("books1", collectionAliasSchema));
     }
 
-    public void testRetrieveAll() throws Exception {
+    @Test
+    void testRetrieveAll() throws Exception {
         CollectionAliasesResponse collectionAliasesResponse = client.aliases().retrieve();
 
         System.out.println(collectionAliasesResponse);
     }
 
-    public void testRetrieveSingleAlias() throws Exception {
+    @Test
+    void testRetrieveSingleAlias() throws Exception {
         CollectionAlias collectionAlias = client.aliases("books").retrieve();
 
         System.out.println(collectionAlias);
     }
 
-    public void testDelete() throws Exception {
+    @Test
+    void testDelete() throws Exception {
         CollectionAlias collectionAlias = client.aliases("books").delete();
 
         System.out.println(collectionAlias);

src/test/java/org/typesense/api/CollectionsTest.java

@@ -1,49 +1,55 @@
 package org.typesense.api;
 
-import junit.framework.TestCase;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.typesense.model.CollectionResponse;
 import org.typesense.model.CollectionSchema;
 import org.typesense.model.Field;
 
 import java.util.ArrayList;
 
 
-public class CollectionsTest extends TestCase {
+class CollectionsTest {
 
-    public Client client;
+    Client client;
     private Helper helper;
 
-    public void setUp() throws Exception {
-        super.setUp();
+    @BeforeEach
+    void setUp() throws Exception {
         helper = new Helper();
         helper.teardown();
         this.client = helper.getClient();
     }
 
-    public void tearDown() throws Exception {
-        super.tearDown();
+    @AfterEach
+    void tearDown() throws Exception {
         helper.teardown();
     }
 
 
-    public void testRetrieveAllCollections() throws Exception {
+    @Test
+    void testRetrieveAllCollections() throws Exception {
         helper.createTestCollection();
         CollectionResponse[] collectionResponses = client.collections().retrieve();
         for(CollectionResponse c:collectionResponses)
             System.out.println(c);
     }
 
-    public void testRetrieveSingleCollection() throws Exception {
+    @Test
+    void testRetrieveSingleCollection() throws Exception {
         helper.createTestCollection();
         System.out.println(client.collections("books").retrieve());
     }
 
-    public void testDeleteCollection() throws Exception {
+    @Test
+    void testDeleteCollection() throws Exception {
         helper.createTestCollection();
         System.out.println(client.collections("books").delete());
     }
 
-    public void testCreateCollection() throws Exception {
+    @Test
+    void testCreateCollection() throws Exception {
 
         ArrayList<Field> fields = new ArrayList<>();
         fields.add(new Field().name("countryName").type(FieldTypes.STRING));

src/test/java/org/typesense/api/DocumentsTest.java

@@ -1,38 +1,48 @@
 package org.typesense.api;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import junit.framework.TestCase;
-import org.junit.Assert;
-import org.typesense.model.*;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.typesense.api.exceptions.ObjectNotFound;
+import org.typesense.model.CollectionSchema;
+import org.typesense.model.DeleteDocumentsParameters;
+import org.typesense.model.ExportDocumentsParameters;
+import org.typesense.model.Field;
+import org.typesense.model.ImportDocumentsParameters;
+import org.typesense.model.SearchParameters;
+import org.typesense.model.SearchResult;
 
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-public class DocumentsTest extends TestCase {
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.fail;
 
-    public Client client;
+class DocumentsTest {
+
+    Client client;
     private Helper helper;
 
-    public void setUp() throws Exception {
-        super.setUp();
+    @BeforeEach
+    void setUp() throws Exception {
         helper = new Helper();
         this.client = helper.getClient();
         helper.teardown();
         helper.createTestCollection();
     }
 
-    public void testRetrieveDocument() throws Exception {
+    @Test
+    void testRetrieveDocument() throws Exception {
         helper.createTestDocument();
         Map<String, Object> resp = client.collections("books").documents("1").retrieve();
-        Assert.assertEquals(6, resp.size());
-        Assert.assertEquals("1", resp.get("id"));
+        assertEquals(6, resp.size());
+        assertEquals("1", resp.get("id"));
     }
 
-    public void testCreateDocument() throws Exception {
+    @Test
+    void testCreateDocument() throws Exception {
         String[] authors = {"shakspeare", "william"};
         HashMap<String, Object> hmap = new HashMap<>();
         hmap.put("title", "Romeo and juliet");
@@ -46,15 +56,16 @@ public void testCreateDocument() throws Exception {
         hmap.put("id", "1");
 
         Map<String, Object> resp = client.collections("books").documents().create(hmap);
-        Assert.assertEquals(9, resp.size());
-        Assert.assertEquals("1", resp.get("id"));
+        assertEquals(9, resp.size());
+        assertEquals("1", resp.get("id"));
     }
 
-    public void testUpsertDocument() throws Exception {
+    @Test
+    void testUpsertDocument() throws Exception {
         helper.createTestDocument();
 
         Map<String, Object> resp = client.collections("books").documents("1").retrieve();
-        Assert.assertEquals("Romeo and juliet", resp.get("title"));
+        assertEquals("Romeo and juliet", resp.get("title"));
 
         String[] authors = new String[]{"jk", "Rowling"};
         HashMap<String, Object> hmap = new HashMap<>();
@@ -69,16 +80,17 @@ public void testUpsertDocument() throws Exception {
         hmap.put("id", "1");
 
         resp = client.collections("books").documents().upsert(hmap);
-        Assert.assertEquals(9, resp.size());
-        Assert.assertEquals("1", resp.get("id"));
-        Assert.assertEquals("harry potter", resp.get("title"));
+        assertEquals(9, resp.size());
+        assertEquals("1", resp.get("id"));
+        assertEquals("harry potter", resp.get("title"));
 
         // try fetching the document back
         resp = client.collections("books").documents("1").retrieve();
-        Assert.assertEquals("harry potter", resp.get("title"));
+        assertEquals("harry potter", resp.get("title"));
     }
 
-    public void testUpdateDocument() throws Exception {
+    @Test
+    void testUpdateDocument() throws Exception {
         helper.createTestDocument();
 
         String[] authors = new String[]{"JK Rowling"};
@@ -91,11 +103,12 @@ public void testUpdateDocument() throws Exception {
 
         // try fetching the document back
         Map<String, Object> resp = client.collections("books").documents("1").retrieve();
-        Assert.assertEquals("harry potter", resp.get("title"));
-        Assert.assertEquals(2000, resp.get("publication_year"));
+        assertEquals("harry potter", resp.get("title"));
+        assertEquals(2000, resp.get("publication_year"));
     }
 
-    public void testDeleteDocument() throws Exception {
+    @Test
+    void testDeleteDocument() throws Exception {
         helper.createTestDocument();
         client.collections("books").documents("1").delete();
 
@@ -107,7 +120,8 @@ public void testDeleteDocument() throws Exception {
         }
     }
 
-    public void testDeleteDocumentByQuery() throws Exception {
+    @Test
+    void testDeleteDocumentByQuery() throws Exception {
         helper.createTestDocument();
         DeleteDocumentsParameters deleteDocumentsParameters = new DeleteDocumentsParameters();
         deleteDocumentsParameters.filterBy("publication_year:=[1666]");
@@ -121,19 +135,21 @@ public void testDeleteDocumentByQuery() throws Exception {
         }
     }
 
-    public void testSearchDocuments() throws Exception {
+    @Test
+    void testSearchDocuments() throws Exception {
         helper.createTestDocument();
         SearchParameters searchParameters = new SearchParameters()
                 .q("romeo")
                 .queryBy("title,authors")
                 .prefix("false,true");
 
         SearchResult searchResult = client.collections("books").documents().search(searchParameters);
-        Assert.assertEquals(1, searchResult.getFound().intValue());
-        Assert.assertEquals(1, searchResult.getHits().size());
+        assertEquals(1, searchResult.getFound().intValue());
+        assertEquals(1, searchResult.getHits().size());
     }
 
-    public void testImport() throws Exception {
+    @Test
+    void testImport() throws Exception {
         HashMap<String, Object> document1 = new HashMap<>();
         HashMap<String, Object> document2 = new HashMap<>();
         ImportDocumentsParameters queryParameters = new ImportDocumentsParameters();
@@ -152,28 +168,31 @@ public void testImport() throws Exception {
 
         String countriesImport = this.client.collections("books").documents()
                 .import_(documentList, queryParameters);
-        Assert.assertFalse(countriesImport.contains("\"success\":false"));
+        assertFalse(countriesImport.contains("\"success\":false"));
     }
 
-    public void testImportAsString() throws Exception {
+    @Test
+    void testImportAsString() throws Exception {
         ImportDocumentsParameters queryParameters = new ImportDocumentsParameters();
         queryParameters.action("create");
         String documentList = "{\"countryName\": \"India\", \"capital\": \"Washington\", \"gdp\": 5215}\n" +
                 "{\"countryName\": \"Iran\", \"capital\": \"London\", \"gdp\": 5215}";
         String booksImport = this.client.collections("books").documents().import_(documentList, queryParameters);
-        Assert.assertFalse(booksImport.contains("\"success\":false"));
+        assertFalse(booksImport.contains("\"success\":false"));
     }
 
-    public void testExportDocuments() throws Exception {
+    @Test
+    void testExportDocuments() throws Exception {
         helper.createTestDocument();
         ExportDocumentsParameters exportDocumentsParameters = new ExportDocumentsParameters();
         exportDocumentsParameters.setExcludeFields("id,publication_year,authors");
         String exportStr = client.collections("books").documents().export(exportDocumentsParameters);
         String expectedExportStr = "{\"average_rating\":3.2,\"ratings_count\":124,\"title\":\"Romeo and juliet\"}";
-        Assert.assertEquals(expectedExportStr, exportStr);
+        assertEquals(expectedExportStr, exportStr);
     }
 
-    public void testDirtyCreate() throws Exception {
+    @Test
+    void testDirtyCreate() throws Exception {
         helper.createTestDocument();
 
         ImportDocumentsParameters queryParameters = new ImportDocumentsParameters();
@@ -193,10 +212,11 @@ public void testDirtyCreate() throws Exception {
 
         this.client.collections("books").documents().create(hmap, queryParameters);
         Map<String, Object> resp = client.collections("books").documents("1").retrieve();
-        Assert.assertEquals("1984", resp.get("title"));
+        assertEquals("1984", resp.get("title"));
     }
 
-    public void testNestedObjectImport() throws Exception {
+    @Test
+    void testNestedObjectImport() throws Exception {
         // create collection with nested objects support
         List<Field> fields = new ArrayList<>();
         fields.add(new Field().name("address").type(FieldTypes.OBJECT).optional(true));
@@ -215,15 +235,15 @@ public void testNestedObjectImport() throws Exception {
                         .addTag("weight", "LOW");
         docs.add(doc);
         String itemImport = this.client.collections("items").documents().import_(docs, queryParameters);
-        Assert.assertFalse(itemImport.contains("\"success\":false"));
+        assertFalse(itemImport.contains("\"success\":false"));
 
         // try searching on the nested document
         SearchParameters searchParameters = new SearchParameters()
                 .q("red")
                 .queryBy("tags");
 
         SearchResult searchResult = client.collections("items").documents().search(searchParameters);
-        Assert.assertEquals(1, searchResult.getFound().intValue());
-        Assert.assertEquals(1, searchResult.getHits().size());
+        assertEquals(1, searchResult.getFound().intValue());
+        assertEquals(1, searchResult.getHits().size());
     }
 }