#2116 fix backup database functionality and add more tests (#2198)

Author: robfrank

.gitignore

@@ -545,3 +545,4 @@ dist
 
 # Python egg metadata
 *.egg-info/
+/backups/

e2e/src/test/java/com/arcadedb/e2e/ArcadeContainerTemplate.java

@@ -20,17 +20,17 @@
 
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.wait.strategy.Wait;
-import org.testcontainers.containers.wait.strategy.WaitAllStrategy;
-import org.testcontainers.containers.wait.strategy.WaitStrategyTarget;
 
-import java.time.*;
+import java.time.Duration;
 
 public abstract class ArcadeContainerTemplate {
-  static final GenericContainer ARCADE;
+  static final GenericContainer<?> ARCADE;
 
   static {
-    ARCADE = new GenericContainer("arcadedata/arcadedb:latest").withExposedPorts(2480, 6379, 5432, 8182)
-        .withStartupTimeout(Duration.ofSeconds(90)).withEnv("JAVA_OPTS", """
+    ARCADE = new GenericContainer<>("arcadedata/arcadedb:latest")
+        .withExposedPorts(2480, 6379, 5432, 8182)
+        .withStartupTimeout(Duration.ofSeconds(90))
+        .withEnv("JAVA_OPTS", """
             -Darcadedb.server.rootPassword=playwithdata
             -Darcadedb.server.defaultDatabases=beer[root]{import:https://github.com/ArcadeData/arcadedb-datasets/raw/main/orientdb/OpenBeer.gz}
             -Darcadedb.server.plugins=Postgres:com.arcadedb.postgres.PostgresProtocolPlugin,GremlinServer:com.arcadedb.server.gremlin.GremlinServerPlugin

e2e/src/test/java/com/arcadedb/e2e/JdbcQueriesTest.java

@@ -91,8 +91,6 @@ void preparedStatement() throws Exception {
     }
   }
 
-
-
   @Test
   void bigResultSetSQLQuery() throws Exception {
 
@@ -269,7 +267,19 @@ void testSelectSchemaTypes() throws SQLException, ClassNotFoundException {
   }
 
   @Test
-//  @Disabled
+  void testBackupDatabase() throws SQLException {
+    try (final Statement stmt = conn.createStatement()) {
+      assertThat(stmt.execute("{sql}BACKUP DATABASE;")).isTrue();
+    }
+
+    try (final Statement stmt = conn.createStatement()) {
+      assertThat(stmt.execute("{sqlscript}BACKUP DATABASE;")).isTrue();
+    }
+
+  }
+
+  @Test
+  @Disabled
   void testMultipleInsert() throws SQLException, ClassNotFoundException {
     try (Statement stmt = conn.createStatement()) {
 

e2e/src/test/java/com/arcadedb/e2e/RemoteDatabaseJavaApiTest.java

@@ -21,12 +21,15 @@
 import com.arcadedb.graph.MutableEdge;
 import com.arcadedb.graph.MutableVertex;
 import com.arcadedb.graph.Vertex;
+import com.arcadedb.query.sql.executor.Result;
 import com.arcadedb.query.sql.executor.ResultSet;
 import com.arcadedb.remote.RemoteDatabase;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
+import java.io.IOException;
 import java.sql.SQLException;
 import java.time.Duration;
 import java.time.LocalDateTime;
@@ -50,6 +53,34 @@ void tearDown() {
       database.close();
   }
 
+  @Test
+  void backupDatabase() throws IOException, InterruptedException {
+
+    ResultSet resultSet = database.command("sql", "BACKUP DATABASE");
+
+    Result result = resultSet.next();
+    assertThat(result.<String>getProperty("result")).isEqualTo("OK");
+    assertThat(result.<String>getProperty("backupFile")).startsWith("beer-backup-");
+
+    resultSet = database.command("sqlscript", "BACKUP DATABASE");
+
+    result = resultSet.next();
+    assertThat(result.<String>getProperty("result")).isEqualTo("OK");
+    assertThat(result.<String>getProperty("backupFile")).startsWith("beer-backup-");
+
+    resultSet = database.command("sqlscript", """
+        BEGIN;
+        INSERT INTO Beer SET name = 'beer1';
+        COMMIT;
+        BACKUP DATABASE;
+        """);
+
+    result = resultSet.next();
+    assertThat(result.<String>getProperty("result")).isEqualTo("OK");
+    assertThat(result.<String>getProperty("backupFile")).startsWith("beer-backup-");
+
+  }
+
   @Test
   void createUnidirectionalEdge() {
 
@@ -119,7 +150,7 @@ SELECT expand( out('HasUploaded') ) FROM Users WHERE id = "u1111"
   }
 
   @Test
-//  @Disabled
+  @Disabled
   void testMultipleInsert() throws SQLException, ClassNotFoundException {
     database.command("sqlscript", """
         create vertex type `TEXT_EMBEDDING` if not exists;
@@ -129,15 +160,13 @@ void testMultipleInsert() throws SQLException, ClassNotFoundException {
 
     LocalDateTime start = LocalDateTime.now();
 
-//    database.transaction(() -> {
-      IntStream.range(1, 100001).forEach(i -> {
+    IntStream.range(1, 100001).forEach(i -> {
 
-        database.command("sqlscript",
-            "INSERT INTO `TEXT_EMBEDDING` SET str = meow_%d, embedding = [0.1,0.2,0.3] RETURN embedding;".formatted(i));
+      database.command("sqlscript",
+          "INSERT INTO `TEXT_EMBEDDING` SET str = meow_%d, embedding = [0.1,0.2,0.3] RETURN embedding;".formatted(i));
 
-      });
+    });
 
-//    });
     LocalDateTime end = LocalDateTime.now();
     System.out.println("Execution time: " + Duration.between(start, end).toSeconds() + " seconds");
 
@@ -147,7 +176,7 @@ void testMultipleInsert() throws SQLException, ClassNotFoundException {
   }
 
   @Test
-//  @Disabled
+  @Disabled
   void testMultipleInsertBAtched() throws SQLException, ClassNotFoundException {
     database.command("sqlscript", """
         create vertex type `TEXT_EMBEDDING` if not exists;

engine/src/main/java/com/arcadedb/query/sql/SQLQueryEngine.java

@@ -40,7 +40,9 @@
 import com.arcadedb.utility.Callable;
 import com.arcadedb.utility.MultiIterator;
 
-import java.util.*;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
 
 import static com.arcadedb.query.sql.parser.SqlParserTreeConstants.JJTLIMIT;
 
@@ -212,7 +214,7 @@ public SQLMethod getMethod(final String name) {
     return methods.createMethod(name);
   }
 
-  public static Statement parse(final String query, final DatabaseInternal database) {
+  public Statement parse(final String query, final DatabaseInternal database) {
     return database.getStatementCache().get(query);
   }
 

engine/src/main/java/com/arcadedb/query/sql/executor/BasicCommandContext.java

@@ -26,7 +26,7 @@
 import java.util.*;
 
 /**
- * Basic implementation of OCommandContext interface that stores variables in a map. Supports parent/child context to build a tree
+ * Basic implementation of CommandContext interface that stores variables in a map. Supports parent/child context to build a tree
  * of contexts. If a variable is not found on current object the search is applied recursively on child contexts.
  *
  * @author Luca Garulli (l.garulli--(at)--gmail.com)

engine/src/main/java/com/arcadedb/query/sql/parser/BackupDatabaseStatement.java

@@ -29,10 +29,10 @@
 import com.arcadedb.query.sql.executor.ResultInternal;
 import com.arcadedb.query.sql.executor.ResultSet;
 
-import java.io.*;
-import java.lang.reflect.*;
-import java.util.*;
-import java.util.logging.*;
+import java.io.File;
+import java.lang.reflect.InvocationTargetException;
+import java.util.Map;
+import java.util.logging.Level;
 
 public class BackupDatabaseStatement extends SimpleExecStatement {
   protected Url url;
@@ -62,16 +62,28 @@ public ResultSet executeSimple(final CommandContext context) {
       String backupDirectory = context.getConfiguration().getValueAsString(GlobalConfiguration.SERVER_BACKUP_DIRECTORY);
       if (!backupDirectory.endsWith(File.separator))
         backupDirectory += File.separator;
+
       clazz.getMethod("setDirectory", String.class).invoke(backup, backupDirectory + context.getDatabase().getName());
-      clazz.getMethod("setVerboseLevel", Integer.TYPE).invoke(backup, 1);
-      final String backupFile = (String) clazz.getMethod("backupDatabase").invoke(backup);
+      clazz.getMethod("setVerboseLevel", Integer.TYPE).invoke(backup, 0);
+      try {
 
-      result.setProperty("result", "OK");
-      result.setProperty("backupFile", backupFile);
+        final String backupFile = (String) clazz.getMethod("backupDatabase").invoke(backup);
+        result.setProperty("result", "OK");
+        result.setProperty("backupFile", backupFile);
 
-      final InternalResultSet rs = new InternalResultSet();
-      rs.add(result);
-      return rs;
+        final InternalResultSet rs = new InternalResultSet();
+        rs.add(result);
+        return rs;
+      } catch (Exception e) {
+        LogManager.instance().log(this, Level.SEVERE,
+            String.format("Error on backup database '%s' to directory '%s'",
+                context.getDatabase().getName(), backupDirectory), e);
+        result.setProperty("result", "ERROR");
+        result.setProperty("error", e.getMessage());
+        final InternalResultSet rs = new InternalResultSet();
+        rs.add(result);
+        return rs;
+      }
 
     } catch (final ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InstantiationException e) {
       throw new CommandExecutionException("Error on backing up database, backup libs not found in classpath", e);

engine/src/test/java/com/arcadedb/TestHelper.java

@@ -148,6 +148,7 @@ protected void endTest() {
 
   @BeforeEach
   public void beforeTest() {
+    GlobalConfiguration.SERVER_ROOT_PATH.setValue("./target");
     if (autoStartTx && !database.isTransactionActive())
       database.begin();
     beginTest();
@@ -173,6 +174,7 @@ public void afterTest() {
 
     checkActiveDatabases();
     FileUtils.deleteRecursively(new File(getDatabasePath()));
+    GlobalConfiguration.resetAll();
   }
 
   @AfterAll

integration/pom.xml

@@ -42,6 +42,13 @@
             <artifactId>arcadedb-engine</artifactId>
             <version>${project.parent.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.arcadedb</groupId>
+            <artifactId>arcadedb-engine</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>test</scope>
+            <type>test-jar</type>
+        </dependency>
         <dependency>
             <groupId>com.sonofab1rd</groupId>
             <artifactId>univocity-parsers</artifactId>

integration/src/main/java/com/arcadedb/integration/backup/BackupSettings.java

@@ -18,9 +18,12 @@
  */
 package com.arcadedb.integration.backup;
 
-import java.io.*;
-import java.text.*;
-import java.util.*;
+import java.io.File;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
 
 public class BackupSettings {
   public       String              format        = "full";
@@ -52,33 +55,38 @@ public void validateSettings() {
 
     if (file == null)
       // ASSIGN DEFAULT FILENAME
-      switch (format) {
-      case "full":
+      if (format.equals("full")) {
         final DateFormat dateFormat = new SimpleDateFormat("yyyyMMdd-HHmmssSSS");
         file = "%s-backup-%s.zip".formatted(databaseName, dateFormat.format(System.currentTimeMillis()));
-        break;
       }
   }
 
   public int parseParameter(final String name, final String value) {
-    if ("format".equals(name)) {
+    switch (name) {
+    case "format" -> {
       if (value != null)
         format = value.toLowerCase(Locale.ENGLISH);
-    } else if ("dir".equals(name)) {
+    }
+    case "dir" -> {
       if (value != null)
         directory = value.endsWith(File.separator) ? value : value + File.separator;
-    } else if ("f".equals(name)) {
+    }
+    case "f" -> {
       if (value != null)
         file = value;
-    } else if ("d".equals(name)) {
+    }
+    case "d" -> {
       if (value != null)
         databaseURL = value;
-    } else if ("o".equals(name)) {
+    }
+    case "o" -> {
       overwriteFile = true;
       return 1;
-    } else
+    }
+    case null, default ->
       // ADDITIONAL OPTIONS
-      options.put(name, value);
+        options.put(name, value);
+    }
     return 2;
   }
 }