In-memory: test in-memory database #194

Ignore tests not compatible with in-memory db.
Assert in-memory database creates no files.

Author: greenrobot-team

tests/objectbox-java-test/build.gradle.kts

@@ -72,7 +72,18 @@ dependencies {
     testImplementation("app.cash.turbine:turbine:0.5.2")
 }
 
-tasks.test {
+val testInMemory by tasks.registering(Test::class) {
+    group = "verification"
+    description = "Run unit tests with in-memory database"
+    systemProperty("obx.inMemory", true)
+}
+
+// Run in-memory tests as part of regular check run
+tasks.check {
+    dependsOn(testInMemory)
+}
+
+tasks.withType<Test> {
     if (System.getenv("TEST_WITH_JAVA_X86") == "true") {
         // To run tests with 32-bit ObjectBox
         // Note: 32-bit JDK is only available on Windows

tests/objectbox-java-test/src/test/java/io/objectbox/AbstractObjectBoxTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2023 ObjectBox Ltd. All rights reserved.
+ * Copyright 2017-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,17 +16,9 @@
 
 package io.objectbox;
 
-import io.objectbox.ModelBuilder.EntityBuilder;
-import io.objectbox.ModelBuilder.PropertyBuilder;
-import io.objectbox.annotation.IndexType;
-import io.objectbox.config.DebugFlags;
-import io.objectbox.model.PropertyFlags;
-import io.objectbox.model.PropertyType;
 import org.junit.After;
 import org.junit.Before;
 
-import javax.annotation.Nullable;
-
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -37,11 +29,22 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Random;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
 
+import javax.annotation.Nullable;
+
+import io.objectbox.ModelBuilder.EntityBuilder;
+import io.objectbox.ModelBuilder.PropertyBuilder;
+import io.objectbox.annotation.IndexType;
+import io.objectbox.config.DebugFlags;
+import io.objectbox.model.PropertyFlags;
+import io.objectbox.model.PropertyType;
+
+
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
@@ -52,6 +55,11 @@ public abstract class AbstractObjectBoxTest {
      * Turns on additional log output, including logging of transactions or query parameters.
      */
     protected static final boolean DEBUG_LOG = false;
+
+    /**
+     * If instead of files the database should be in memory.
+     */
+    protected static final boolean IN_MEMORY = Objects.equals(System.getProperty("obx.inMemory"), "true");
     private static boolean printedVersionsOnce;
 
     protected File boxStoreDir;
@@ -92,6 +100,7 @@ public void setUp() throws IOException {
             System.out.println("ObjectBox Java version: " + BoxStore.getVersion());
             System.out.println("ObjectBox Core version: " + BoxStore.getVersionNative());
             System.out.println("First DB dir: " + boxStoreDir);
+            System.out.println("IN_MEMORY=" + IN_MEMORY);
             System.out.println("java.version=" + System.getProperty("java.version"));
             System.out.println("file.encoding=" + System.getProperty("file.encoding"));
             System.out.println("sun.jnu.encoding=" + System.getProperty("sun.jnu.encoding"));
@@ -105,11 +114,20 @@ public void setUp() throws IOException {
      * This works with Android without needing any context.
      */
     protected File prepareTempDir(String prefix) throws IOException {
-        File tempFile = File.createTempFile(prefix, "");
-        if (!tempFile.delete()) {
-            throw new IOException("Could not prep temp dir; file delete failed for " + tempFile.getAbsolutePath());
+        if (IN_MEMORY) {
+            // Instead of random temp directory, use random suffix for each test to avoid re-using existing database
+            // from other tests in case clean-up fails.
+            // Note: all clean-up code will gracefully fail (e.g. deleting the database files will do nothing as the
+            // directory does not exist).
+            String randomPart = Long.toUnsignedString(random.nextLong());
+            return new File(BoxStore.IN_MEMORY_PREFIX + prefix + randomPart);
+        } else {
+            File tempFile = File.createTempFile(prefix, "");
+            if (!tempFile.delete()) {
+                throw new IOException("Could not prep temp dir; file delete failed for " + tempFile.getAbsolutePath());
+            }
+            return tempFile;
         }
-        return tempFile;
     }
 
     protected BoxStore createBoxStore() {

tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreBuilderTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2023 ObjectBox Ltd. All rights reserved.
+ * Copyright 2017-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,9 @@
 
 package io.objectbox;
 
+import org.junit.Before;
+import org.junit.Test;
+
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -28,14 +31,14 @@
 
 import io.objectbox.exception.DbFullException;
 import io.objectbox.exception.DbMaxDataSizeExceededException;
-import org.junit.Before;
-import org.junit.Test;
+
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeFalse;
 
 public class BoxStoreBuilderTest extends AbstractObjectBoxTest {
 
@@ -186,6 +189,8 @@ public void maxSize_invalidValues_throw() {
 
     @Test
     public void maxFileSize() {
+        assumeFalse(IN_MEMORY); // no max size support for in-memory
+
         builder = createBoxStoreBuilder(null);
         builder.maxSizeInKByte(30); // Empty file is around 12 KB, object below adds about 8 KB each.
         store = builder.build();

tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ObjectBox Ltd. All rights reserved.
+ * Copyright 2017-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,14 +16,16 @@
 
 package io.objectbox;
 
-import io.objectbox.exception.DbException;
 import org.junit.Test;
 import org.junit.function.ThrowingRunnable;
 
 import java.io.File;
 import java.util.concurrent.Callable;
 import java.util.concurrent.RejectedExecutionException;
 
+import io.objectbox.exception.DbException;
+
+
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
@@ -32,6 +34,8 @@
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeFalse;
+import static org.junit.Assume.assumeTrue;
 
 public class BoxStoreTest extends AbstractObjectBoxTest {
 
@@ -178,12 +182,15 @@ public void testOpenTwoBoxStoreTwoFiles() {
 
     @Test
     public void testDeleteAllFiles() {
+        assumeFalse(IN_MEMORY);
         closeStoreForTest();
     }
 
     @Test
     public void testDeleteAllFiles_staticDir() {
+        assumeFalse(IN_MEMORY);
         closeStoreForTest();
+
         File boxStoreDir2 = new File(boxStoreDir.getAbsolutePath() + "-2");
         BoxStoreBuilder builder = new BoxStoreBuilder(createTestModel(null)).directory(boxStoreDir2);
         BoxStore store2 = builder.build();
@@ -196,6 +203,8 @@ public void testDeleteAllFiles_staticDir() {
 
     @Test
     public void testDeleteAllFiles_baseDirName() {
+        assumeFalse(IN_MEMORY);
+
         closeStoreForTest();
         File basedir = new File("test-base-dir");
         String name = "mydb";
@@ -220,6 +229,7 @@ public void testDeleteAllFiles_baseDirName() {
 
     @Test(expected = IllegalStateException.class)
     public void testDeleteAllFiles_openStore() {
+        assumeFalse(IN_MEMORY);
         BoxStore.deleteAllFiles(boxStoreDir);
     }
 
@@ -245,9 +255,13 @@ public void removeAllObjects() {
     }
 
     private void closeStoreForTest() {
-        assertTrue(boxStoreDir.exists());
+        if (!IN_MEMORY) {
+            assertTrue(boxStoreDir.exists());
+        }
         store.close();
-        assertTrue(store.deleteAllFiles());
+        if (!IN_MEMORY) {
+            assertTrue(store.deleteAllFiles());
+        }
         assertFalse(boxStoreDir.exists());
     }
 
@@ -295,22 +309,36 @@ private Callable<String> createTestCallable(final int[] countHolder) {
 
     @Test
     public void testSizeOnDisk() {
+        assumeFalse(IN_MEMORY);
+
         long size = store.sizeOnDisk();
         assertTrue(size >= 8192);
     }
 
+    @Test
+    public void testInMemory_createsNoFiles() {
+        assumeTrue(IN_MEMORY);
+
+        assertFalse(boxStoreDir.exists());
+        assertFalse(new File("memory").exists());
+        assertFalse(new File("memory:").exists());
+        String identifierPart = boxStoreDir.getPath().substring("memory:".length());
+        assertFalse(new File(identifierPart).exists());
+    }
+
     @Test
     public void validate() {
         putTestEntities(100);
 
+        // Note: not implemented for in-memory, returns 0.
         // No limit.
         long validated = store.validate(0, true);
-        assertEquals(14, validated);
+        assertEquals(IN_MEMORY ? 0 : 14, validated);
 
         // With limit.
         validated = store.validate(1, true);
         // 2 because the first page doesn't contain any actual data?
-        assertEquals(2, validated);
+        assertEquals(IN_MEMORY ? 0 : 2, validated);
     }
 
     @Test

tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreValidationTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 ObjectBox Ltd. All rights reserved.
+ * Copyright 2023-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,10 @@
 
 package io.objectbox;
 
+import org.greenrobot.essentials.io.IoUtils;
+import org.junit.Before;
+import org.junit.Test;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -24,15 +28,14 @@
 import io.objectbox.config.ValidateOnOpenModePages;
 import io.objectbox.exception.FileCorruptException;
 import io.objectbox.exception.PagesCorruptException;
-import org.greenrobot.essentials.io.IoUtils;
-import org.junit.Before;
-import org.junit.Test;
+
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeFalse;
 
 /**
  * Tests validation (and recovery) options on opening a store.
@@ -71,6 +74,8 @@ public void validateOnOpen() {
 
     @Test
     public void validateOnOpenCorruptFile() throws IOException {
+        assumeFalse(IN_MEMORY);
+
         File dir = prepareTempDir("object-store-test-corrupted");
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
 
@@ -87,6 +92,8 @@ public void validateOnOpenCorruptFile() throws IOException {
 
     @Test
     public void usePreviousCommitWithCorruptFile() throws IOException {
+        assumeFalse(IN_MEMORY);
+
         File dir = prepareTempDir("object-store-test-corrupted");
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
@@ -101,6 +108,8 @@ public void usePreviousCommitWithCorruptFile() throws IOException {
 
     @Test
     public void usePreviousCommitAfterFileCorruptException() throws IOException {
+        assumeFalse(IN_MEMORY);
+
         File dir = prepareTempDir("object-store-test-corrupted");
         prepareBadDataFile(dir, "corrupt-pageno-in-branch-data.mdb");
         builder = BoxStoreBuilder.createDebugWithoutModel().directory(dir);
@@ -137,6 +146,8 @@ public void validateOnOpenKv() {
 
     @Test
     public void validateOnOpenKvCorruptFile() throws IOException {
+        assumeFalse(IN_MEMORY);
+        
         File dir = prepareTempDir("obx-store-validate-kv-corrupted");
         prepareBadDataFile(dir, "corrupt-keysize0-data.mdb");