Allow specifying a custom cluster file to YamlTestExtension

ScottDugas · ScottDugas · commit cadc50947135 · 2025-03-17T12:11:37.000-04:00
This allows running yamsql tests with a custom cluster file that is not specified via the environment variable. This doesn't add support for doing this with the @yamltest annotation.
diff --git a/fdb-relational-server/src/main/java/com/apple/foundationdb/relational/server/FRL.java b/fdb-relational-server/src/main/java/com/apple/foundationdb/relational/server/FRL.java
@@ -83,12 +83,12 @@ public class FRL implements AutoCloseable {
 
     @SpotBugsSuppressWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Should consider refactoring but throwing exceptions for now")
     public FRL() throws RelationalException {
-        this(Options.NONE);
+        this(Options.NONE, null);
     }
 
     @SpotBugsSuppressWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Should consider refactoring but throwing exceptions for now")
-    public FRL(@Nonnull Options options) throws RelationalException {
-        final FDBDatabase fdbDb = FDBDatabaseFactory.instance().getDatabase();
+    public FRL(@Nonnull Options options, @Nullable String clusterFile) throws RelationalException {
+        final FDBDatabase fdbDb = FDBDatabaseFactory.instance().getDatabase(clusterFile);
         final Long asyncToSyncTimeout = options.getOption(Options.Name.ASYNC_OPERATIONS_TIMEOUT_MILLIS);
         if (asyncToSyncTimeout > 0) {
             fdbDb.setAsyncToSyncTimeout(asyncToSyncTimeout, TimeUnit.MILLISECONDS);
diff --git a/fdb-relational-server/src/main/java/com/apple/foundationdb/relational/server/InProcessRelationalServer.java b/fdb-relational-server/src/main/java/com/apple/foundationdb/relational/server/InProcessRelationalServer.java
@@ -22,12 +22,14 @@
 
 import com.apple.foundationdb.annotation.API;
 
+import com.apple.foundationdb.relational.api.Options;
 import com.apple.foundationdb.relational.api.exceptions.RelationalException;
 import com.apple.foundationdb.relational.server.jdbc.v1.JDBCService;
 
 import io.grpc.Server;
 import io.grpc.inprocess.InProcessServerBuilder;
 
+import javax.annotation.Nullable;
 import java.io.Closeable;
 import java.io.IOException;
 import java.io.InterruptedIOException;
@@ -46,13 +48,20 @@ public class InProcessRelationalServer implements Closeable {
     private Server grpcInProcessServer;
     private FRL frl;
     private final String serverName;
+    @Nullable
+    private final String clusterFile;
 
     public InProcessRelationalServer() {
-        this(InProcessServerBuilder.generateName());
+        this(InProcessServerBuilder.generateName(), null);
     }
 
-    InProcessRelationalServer(String serverName) {
+    public InProcessRelationalServer(@Nullable final String clusterFile) {
+        this(InProcessServerBuilder.generateName(), clusterFile);
+    }
+
+    InProcessRelationalServer(String serverName, @Nullable final String clusterFile) {
         this.serverName = serverName;
+        this.clusterFile = clusterFile;
     }
 
     public String getServerName() {
@@ -68,7 +77,7 @@ public InProcessRelationalServer start() throws IOException {
         // Create access to backing database.
         // TODO: Make this multi-query/-tenant/-database!
         try {
-            this.frl = new FRL();
+            this.frl = new FRL(Options.NONE, clusterFile);
         } catch (RelationalException ve) {
             throw new IOException(ve);
         }
diff --git a/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/YamlTestExtension.java b/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/YamlTestExtension.java
@@ -64,11 +64,20 @@ public class YamlTestExtension implements TestTemplateInvocationContextProvider,
     private List<YamlTestConfig> testConfigs;
     private List<YamlTestConfig> maintainConfigs;
     private List<ExternalServer> servers;
+    private final String clusterFile;
+
+    public YamlTestExtension() {
+        this.clusterFile = System.getenv("FDB_CLUSTER_FILE");
+    }
+
+    public YamlTestExtension(final String clusterFile) {
+        this.clusterFile = clusterFile;
+    }
 
     @Override
     public void beforeAll(final ExtensionContext context) throws Exception {
         if (Boolean.parseBoolean(System.getProperty("tests.runQuick", "false"))) {
-            testConfigs = List.of(new EmbeddedConfig());
+            testConfigs = List.of(new EmbeddedConfig(clusterFile));
             maintainConfigs = List.of();
         } else {
             AtomicInteger serverPort = new AtomicInteger(1111);
@@ -78,7 +87,9 @@ public void beforeAll(final ExtensionContext context) throws Exception {
             // Potentially, we can relax this a little if all tests are disabled for multi-server execution, but this is
             // not a likely scenario.
             Assertions.assertFalse(jars.isEmpty(), "There are no external servers available to run");
-            servers = jars.stream().map(jar -> new ExternalServer(jar, serverPort.getAndIncrement(), serverPort.getAndIncrement())).collect(Collectors.toList());
+            servers = jars.stream()
+                    .map(jar -> new ExternalServer(jar, serverPort.getAndIncrement(), serverPort.getAndIncrement(), clusterFile))
+                    .collect(Collectors.toList());
             for (ExternalServer server : servers) {
                 server.start();
             }
@@ -94,10 +105,10 @@ public void beforeAll(final ExtensionContext context) throws Exception {
                     externalServerConfigs).collect(Collectors.toList());
 
             maintainConfigs = List.of(
-                    new CorrectExplains(new EmbeddedConfig()),
-                    new CorrectMetrics(new EmbeddedConfig()),
-                    new CorrectExplainsAndMetrics(new EmbeddedConfig()),
-                    new ShowPlanOnDiff(new EmbeddedConfig())
+                    new CorrectExplains(new EmbeddedConfig(clusterFile)),
+                    new CorrectMetrics(new EmbeddedConfig(clusterFile)),
+                    new CorrectExplainsAndMetrics(new EmbeddedConfig(clusterFile)),
+                    new ShowPlanOnDiff(new EmbeddedConfig(clusterFile))
             );
         }
         for (final YamlTestConfig testConfig : Iterables.concat(testConfigs, maintainConfigs)) {
@@ -109,7 +120,7 @@ private Stream<YamlTestConfig> localConfigs(final boolean mixedModeOnly, final b
         if (mixedModeOnly || singleExternalVersionOnly) {
             return Stream.of();
         } else {
-            return Stream.of(new EmbeddedConfig(), new JDBCInProcessConfig());
+            return Stream.of(new EmbeddedConfig(clusterFile), new JDBCInProcessConfig(clusterFile));
         }
     }
 
@@ -124,10 +135,10 @@ private Stream<YamlTestConfig> externalServerConfigs(final boolean singleExterna
         } else {
             return servers.stream().flatMap(server ->
                     // (4 configs for each server available)
-                    Stream.of(new JDBCMultiServerConfig(0, server),
-                            new ForceContinuations(new JDBCMultiServerConfig(0, server)),
-                            new JDBCMultiServerConfig(1, server),
-                            new ForceContinuations(new JDBCMultiServerConfig(1, server))));
+                    Stream.of(new JDBCMultiServerConfig(0, server, clusterFile),
+                            new ForceContinuations(new JDBCMultiServerConfig(0, server, clusterFile)),
+                            new JDBCMultiServerConfig(1, server, clusterFile),
+                            new ForceContinuations(new JDBCMultiServerConfig(1, server, clusterFile))));
         }
     }
 
diff --git a/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/EmbeddedConfig.java b/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/EmbeddedConfig.java
@@ -33,6 +33,11 @@
  */
 public class EmbeddedConfig implements YamlTestConfig {
     private FRL frl;
+    private final String clusterFile;
+
+    public EmbeddedConfig(final String clusterFile) {
+        this.clusterFile = clusterFile;
+    }
 
     @Override
     public void beforeAll() throws Exception {
@@ -42,7 +47,7 @@ public void beforeAll() throws Exception {
                 .withOption(Options.Name.PLAN_CACHE_TERTIARY_TIME_TO_LIVE_MILLIS, 3_600_000L)
                 .withOption(Options.Name.PLAN_CACHE_PRIMARY_MAX_ENTRIES, 10)
                 .build();
-        frl = new FRL(options);
+        frl = new FRL(options, clusterFile);
     }
 
     @Override
diff --git a/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/JDBCInProcessConfig.java b/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/JDBCInProcessConfig.java
@@ -34,11 +34,17 @@
 public class JDBCInProcessConfig implements YamlTestConfig {
     @Nullable
     private InProcessRelationalServer server;
+    @Nullable
+    private final String clusterFile;
+
+    public JDBCInProcessConfig(@Nullable final String clusterFile) {
+        this.clusterFile = clusterFile;
+    }
 
     @Override
     public void beforeAll() throws Exception {
         try {
-            server = new InProcessRelationalServer().start();
+            server = new InProcessRelationalServer(clusterFile).start();
         } catch (Exception e) {
             throw new RuntimeException(e);
         }
diff --git a/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/JDBCMultiServerConfig.java b/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/configs/JDBCMultiServerConfig.java
@@ -35,8 +35,8 @@ public class JDBCMultiServerConfig extends JDBCInProcessConfig {
     private final ExternalServer externalServer;
     private final int initialConnection;
 
-    public JDBCMultiServerConfig(final int initialConnection, ExternalServer externalServer) {
-        super();
+    public JDBCMultiServerConfig(final int initialConnection, ExternalServer externalServer, final String clusterFile) {
+        super(clusterFile);
         this.initialConnection = initialConnection;
         this.externalServer = externalServer;
     }
diff --git a/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/server/ExternalServer.java b/yaml-tests/src/main/java/com/apple/foundationdb/relational/yamltests/server/ExternalServer.java
@@ -48,24 +48,18 @@ public class ExternalServer {
     private final int httpPort;
     private SemanticVersion version;
     private Process serverProcess;
-
-    /**
-     * Create a new instance that will run latest released version of the server, as downloaded by gradle.
-     * This assumes only one server exists in the download directory.
-     */
-    public ExternalServer(final int grpcPort, final int httpPort) {
-        this(null, grpcPort, httpPort);
-    }
+    private String clusterFile;
 
     /**
      * Create a new instance that will run a specific jar.
      *
      * @param serverJar the path to the jar to run
      */
-    public ExternalServer(File serverJar, final int grpcPort, final int httpPort) {
+    public ExternalServer(File serverJar, final int grpcPort, final int httpPort, final String clusterFile) {
         this.serverJar = serverJar;
         this.grpcPort = grpcPort;
         this.httpPort = httpPort;
+        this.clusterFile = clusterFile;
     }
 
     static {
@@ -129,6 +123,7 @@ public void start() throws Exception {
                                       ProcessBuilder.Redirect.DISCARD;
         processBuilder.redirectOutput(out);
         processBuilder.redirectError(err);
+        processBuilder.environment().put("FDB_CLUSTER_FILE", clusterFile);
 
         if (!startServer(processBuilder)) {
             Assertions.fail("Failed to start the external server");
diff --git a/yaml-tests/src/test/java/InitialVersionTest.java b/yaml-tests/src/test/java/InitialVersionTest.java
@@ -44,7 +44,7 @@
  */
 public class InitialVersionTest {
     private static final SemanticVersion VERSION = SemanticVersion.parse("3.0.18.0");
-    private static final EmbeddedConfig config = new EmbeddedConfig();
+    private static final EmbeddedConfig config = new EmbeddedConfig(null);
 
     @BeforeAll
     static void beforeAll() throws Exception {
diff --git a/yaml-tests/src/test/java/SupportedVersionTest.java b/yaml-tests/src/test/java/SupportedVersionTest.java
@@ -45,7 +45,7 @@
 public class SupportedVersionTest {
 
     private static final SemanticVersion VERSION = SemanticVersion.parse("3.0.18.0");
-    private static final EmbeddedConfig config = new EmbeddedConfig();
+    private static final EmbeddedConfig config = new EmbeddedConfig(null);
 
     @BeforeAll
     static void beforeAll() throws Exception {
diff --git a/yaml-tests/src/test/java/YamlTestBase.java b/yaml-tests/src/test/java/YamlTestBase.java
@@ -37,7 +37,7 @@ public static void beforeAll() throws RelationalException, SQLException {
                 .withOption(Options.Name.PLAN_CACHE_SECONDARY_TIME_TO_LIVE_MILLIS, 3_600_000L)
                 .withOption(Options.Name.PLAN_CACHE_TERTIARY_TIME_TO_LIVE_MILLIS, 3_600_000L)
                 .build();
-        frl = new FRL(options);
+        frl = new FRL(options, null);
     }
 
     @AfterAll

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public static void beforeAll() throws RelationalException, SQLException {`
`37`	`37`	`.withOption(Options.Name.PLAN_CACHE_SECONDARY_TIME_TO_LIVE_MILLIS, 3_600_000L)`
`38`	`38`	`.withOption(Options.Name.PLAN_CACHE_TERTIARY_TIME_TO_LIVE_MILLIS, 3_600_000L)`
`39`	`39`	`.build();`
`40`		`- frl = new FRL(options);`
	`40`	`+ frl = new FRL(options, null);`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@AfterAll`