Use SPI to handle StorageContainerConfigurationOption (#36576)

terrymanu · web-flow · commit 3837077844aa · 2025-09-16T09:18:35.000+08:00
diff --git a/test/e2e/agent/engine/src/test/java/org/apache/shardingsphere/test/e2e/agent/engine/env/AgentE2ETestEnvironment.java b/test/e2e/agent/engine/src/test/java/org/apache/shardingsphere/test/e2e/agent/engine/env/AgentE2ETestEnvironment.java
@@ -22,6 +22,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPILoader;
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.infra.spi.type.typed.TypedSPILoader;
 import org.apache.shardingsphere.test.e2e.agent.engine.container.ShardingSphereJdbcAgentContainer;
@@ -38,7 +39,7 @@
 import org.apache.shardingsphere.test.e2e.env.container.atomic.enums.AdapterType;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.governance.GovernanceContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.governance.GovernanceContainerFactory;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
+import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.type.docker.DockerStorageContainer;
 import org.awaitility.Awaitility;
 import org.testcontainers.containers.output.OutputFrame;
@@ -115,7 +116,8 @@ private void createProxyEnvironment(final DockerITContainer agentPluginContainer
         containers = new ITContainers();
         ShardingSphereProxyClusterContainer proxyContainer = new ShardingSphereProxyClusterContainer(databaseType, getAdaptorContainerConfiguration());
         proxyContainer.withLogConsumer(testConfig.isLogEnabled() ? this::collectLogs : null);
-        DockerStorageContainer storageContainer = new DockerStorageContainer(databaseType, imageConfig.getMysqlImage(), StorageContainerConfigurationOptionFactory.newInstance(databaseType), null);
+        DockerStorageContainer storageContainer = new DockerStorageContainer(
+                databaseType, imageConfig.getMysqlImage(), DatabaseTypedSPILoader.getService(StorageContainerConfigurationOption.class, databaseType), null);
         proxyContainer.dependsOn(storageContainer);
         containers.registerContainer(storageContainer);
         GovernanceContainer governanceContainer = GovernanceContainerFactory.newInstance("ZooKeeper");
@@ -146,7 +148,8 @@ private AdaptorContainerConfiguration getAdaptorContainerConfiguration() {
     
     private void createJDBCEnvironment(final DockerITContainer agentPluginContainer) {
         containers = new ITContainers();
-        DockerStorageContainer storageContainer = new DockerStorageContainer(databaseType, imageConfig.getMysqlImage(), StorageContainerConfigurationOptionFactory.newInstance(databaseType), null);
+        DockerStorageContainer storageContainer = new DockerStorageContainer(
+                databaseType, imageConfig.getMysqlImage(), DatabaseTypedSPILoader.getService(StorageContainerConfigurationOption.class, databaseType), null);
         ShardingSphereJdbcAgentContainer jdbcAgentContainer = new ShardingSphereJdbcAgentContainer(
                 imageConfig.getJdbcProjectImage(), testConfig.getPluginType(), testConfig.isLogEnabled() ? this::collectLogs : null);
         jdbcAgentContainer.dependsOn(storageContainer);
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/StorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/StorageContainerConfigurationOption.java
@@ -17,6 +17,8 @@
 
 package org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option;
 
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPI;
+
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
@@ -25,7 +27,7 @@
 /**
  * Storage container configuration option.
  */
-public interface StorageContainerConfigurationOption {
+public interface StorageContainerConfigurationOption extends DatabaseTypedSPI {
     
     /**
      * Get container port.
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/StorageContainerConfigurationOptionFactory.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/StorageContainerConfigurationOptionFactory.java
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/HiveStorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/HiveStorageContainerConfigurationOption.java
@@ -84,4 +84,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {
     public long getStartupTimeoutSeconds() {
         return 180L;
     }
+    
+    @Override
+    public String getDatabaseType() {
+        return "Hive";
+    }
 }
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/MariaDBStorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/MariaDBStorageContainerConfigurationOption.java
@@ -84,4 +84,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {
     public long getStartupTimeoutSeconds() {
         return 120L;
     }
+    
+    @Override
+    public String getDatabaseType() {
+        return "MariaDB";
+    }
 }
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/MySQLStorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/MySQLStorageContainerConfigurationOption.java
@@ -90,4 +90,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {
     public long getStartupTimeoutSeconds() {
         return 120L;
     }
+    
+    @Override
+    public String getDatabaseType() {
+        return "MySQL";
+    }
 }
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/OpenGaussStorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/OpenGaussStorageContainerConfigurationOption.java
@@ -81,4 +81,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {
     public long getStartupTimeoutSeconds() {
         return 120L;
     }
+    
+    @Override
+    public String getDatabaseType() {
+        return "openGauss";
+    }
 }
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/PostgreSQLStorageContainerConfigurationOption.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/option/dialect/PostgreSQLStorageContainerConfigurationOption.java
@@ -28,7 +28,7 @@
 import java.util.Optional;
 
 /**
- * Storage container configuration option for  PostgreSQL.
+ * Storage container configuration option for PostgreSQL.
  */
 public final class PostgreSQLStorageContainerConfigurationOption implements StorageContainerConfigurationOption {
     
@@ -84,4 +84,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {
     public long getStartupTimeoutSeconds() {
         return 120L;
     }
+    
+    @Override
+    public String getDatabaseType() {
+        return "PostgreSQL";
+    }
 }
diff --git a/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/type/natived/NativeStorageContainer.java b/test/e2e/env/src/test/java/org/apache/shardingsphere/test/e2e/env/container/atomic/storage/type/natived/NativeStorageContainer.java
@@ -19,12 +19,12 @@
 
 import lombok.Getter;
 import lombok.Setter;
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPILoader;
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.constants.StorageContainerConstants;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.mount.MountSQLResourceGenerator;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.util.SQLScriptUtils;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.util.StorageContainerUtils;
 import org.apache.shardingsphere.test.e2e.env.runtime.DataSourceEnvironment;
@@ -65,7 +65,7 @@ public final class NativeStorageContainer implements StorageContainer {
     public NativeStorageContainer(final DatabaseType databaseType, final String scenario) {
         this.databaseType = databaseType;
         this.scenario = scenario;
-        option = StorageContainerConfigurationOptionFactory.newInstance(databaseType);
+        option = DatabaseTypedSPILoader.findService(StorageContainerConfigurationOption.class, databaseType).orElse(null);
         initDatabase();
         actualDataSourceMap = createDataSourceMap(Type.ACTUAL);
         expectedDataSourceMap = createDataSourceMap(Type.EXPECTED);
diff --git a/test/e2e/env/src/test/resources/META-INF/services/org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption b/test/e2e/env/src/test/resources/META-INF/services/org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption
@@ -0,0 +1,22 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.dialect.MySQLStorageContainerConfigurationOption
+org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.dialect.PostgreSQLStorageContainerConfigurationOption
+org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.dialect.MariaDBStorageContainerConfigurationOption
+org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.dialect.OpenGaussStorageContainerConfigurationOption
+org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.dialect.HiveStorageContainerConfigurationOption
diff --git a/test/e2e/operation/pipeline/src/test/java/org/apache/shardingsphere/test/e2e/operation/pipeline/cases/createtable/CreateTableSQLGeneratorIT.java b/test/e2e/operation/pipeline/src/test/java/org/apache/shardingsphere/test/e2e/operation/pipeline/cases/createtable/CreateTableSQLGeneratorIT.java
@@ -22,7 +22,7 @@
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.infra.spi.type.typed.TypedSPILoader;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainerFactory;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
+import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.type.docker.DockerStorageContainer;
 import org.apache.shardingsphere.test.e2e.operation.pipeline.entity.CreateTableSQLGeneratorAssertionEntity;
 import org.apache.shardingsphere.test.e2e.operation.pipeline.entity.CreateTableSQLGeneratorAssertionsRootEntity;
@@ -93,7 +93,7 @@ void assertGenerateCreateTableSQL(final PipelineTestParameter testParam) throws
     
     private void startStorageContainer(final DatabaseType databaseType, final String storageContainerImage) {
         storageContainer = (DockerStorageContainer) StorageContainerFactory.newInstance(
-                databaseType, storageContainerImage, StorageContainerConfigurationOptionFactory.newInstance(databaseType), null);
+                databaseType, storageContainerImage, DatabaseTypedSPILoader.findService(StorageContainerConfigurationOption.class, databaseType).orElse(null), null);
         storageContainer.start();
     }
     
diff --git a/test/e2e/operation/pipeline/src/test/java/org/apache/shardingsphere/test/e2e/operation/pipeline/framework/container/compose/DockerContainerComposer.java b/test/e2e/operation/pipeline/src/test/java/org/apache/shardingsphere/test/e2e/operation/pipeline/framework/container/compose/DockerContainerComposer.java
@@ -18,6 +18,7 @@
 package org.apache.shardingsphere.test.e2e.operation.pipeline.framework.container.compose;
 
 import lombok.Getter;
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPILoader;
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.infra.spi.type.typed.TypedSPILoader;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.adapter.config.AdaptorContainerConfiguration;
@@ -26,7 +27,7 @@
 import org.apache.shardingsphere.test.e2e.env.container.atomic.governance.GovernanceContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.governance.impl.ZookeeperContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainerFactory;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
+import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.type.docker.DockerStorageContainer;
 import org.apache.shardingsphere.test.e2e.env.runtime.DataSourceEnvironment;
 import org.apache.shardingsphere.test.e2e.operation.pipeline.env.PipelineE2EEnvironment;
@@ -60,8 +61,8 @@ public DockerContainerComposer(final DatabaseType databaseType, final String sto
             throw new InvalidParameterException("storageContainerCount must >= 1");
         }
         for (int i = 0; i < storageContainerCount; i++) {
-            DockerStorageContainer storageContainer = getContainers().registerContainer(
-                    (DockerStorageContainer) StorageContainerFactory.newInstance(databaseType, storageContainerImage, StorageContainerConfigurationOptionFactory.newInstance(databaseType), null));
+            DockerStorageContainer storageContainer = getContainers().registerContainer((DockerStorageContainer) StorageContainerFactory.newInstance(
+                    databaseType, storageContainerImage, DatabaseTypedSPILoader.findService(StorageContainerConfigurationOption.class, databaseType).orElse(null), null));
             storageContainer.setNetworkAliases(Collections.singletonList(String.join(".", databaseType.getType().toLowerCase() + "_" + i, "host")));
             storageContainers.add(storageContainer);
         }
diff --git a/test/e2e/operation/showprocesslist/src/test/java/org/apache/shardingsphere/test/e2e/operation/showprocesslist/container/composer/ClusterShowProcessListContainerComposer.java b/test/e2e/operation/showprocesslist/src/test/java/org/apache/shardingsphere/test/e2e/operation/showprocesslist/container/composer/ClusterShowProcessListContainerComposer.java
@@ -17,6 +17,7 @@
 
 package org.apache.shardingsphere.test.e2e.operation.showprocesslist.container.composer;
 
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPILoader;
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.DockerITContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.ITContainers;
@@ -31,7 +32,6 @@
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainerFactory;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.util.AdapterContainerUtils;
 import org.apache.shardingsphere.test.e2e.operation.showprocesslist.env.ShowProcessListEnvironment;
 import org.apache.shardingsphere.test.e2e.operation.showprocesslist.parameter.ShowProcessListTestParameter;
@@ -57,7 +57,7 @@ public final class ClusterShowProcessListContainerComposer implements AutoClosea
     public ClusterShowProcessListContainerComposer(final ShowProcessListTestParameter testParam) {
         containers = new ITContainers(testParam.getScenario());
         governanceContainer = isClusterMode(testParam.getRunMode()) ? containers.registerContainer(GovernanceContainerFactory.newInstance("ZooKeeper")) : null;
-        StorageContainerConfigurationOption option = StorageContainerConfigurationOptionFactory.newInstance(testParam.getDatabaseType());
+        StorageContainerConfigurationOption option = DatabaseTypedSPILoader.findService(StorageContainerConfigurationOption.class, testParam.getDatabaseType()).orElse(null);
         StorageContainer storageContainer = containers.registerContainer(StorageContainerFactory.newInstance(testParam.getDatabaseType(), "", option, testParam.getScenario()));
         AdaptorContainerConfiguration containerConfig = new AdaptorContainerConfiguration(testParam.getScenario(), new LinkedList<>(),
                 getMountedResources(testParam.getScenario(), testParam.getDatabaseType(), testParam.getRunMode(), testParam.getGovernanceCenter()), AdapterContainerUtils.getAdapterContainerImage(),
diff --git a/test/e2e/operation/transaction/src/test/java/org/apache/shardingsphere/test/e2e/operation/transaction/framework/container/compose/DockerContainerComposer.java b/test/e2e/operation/transaction/src/test/java/org/apache/shardingsphere/test/e2e/operation/transaction/framework/container/compose/DockerContainerComposer.java
@@ -20,6 +20,7 @@
 import com.google.common.base.Strings;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.shardingsphere.database.connector.core.spi.DatabaseTypedSPILoader;
 import org.apache.shardingsphere.database.connector.core.type.DatabaseType;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.DockerITContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.adapter.AdapterContainer;
@@ -33,7 +34,7 @@
 import org.apache.shardingsphere.test.e2e.env.container.atomic.governance.impl.ZookeeperContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.StorageContainerFactory;
-import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOptionFactory;
+import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.option.StorageContainerConfigurationOption;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.type.docker.DockerStorageContainer;
 import org.apache.shardingsphere.test.e2e.env.container.atomic.storage.type.natived.NativeStorageContainer;
 import org.apache.shardingsphere.test.e2e.operation.transaction.env.TransactionE2EEnvironment;
@@ -67,8 +68,8 @@ public DockerContainerComposer(final TransactionTestParameter testParam) {
         governanceContainer = getContainers().registerContainer(new ZookeeperContainer());
         TransactionE2EEnvTypeEnum envType = TransactionE2EEnvironment.getInstance().getItEnvType();
         if (TransactionE2EEnvTypeEnum.DOCKER == envType) {
-            storageContainer = getContainers().registerContainer((DockerStorageContainer) StorageContainerFactory.newInstance(
-                    databaseType, testParam.getStorageContainerImage(), StorageContainerConfigurationOptionFactory.newInstance(databaseType), testParam.getScenario()));
+            storageContainer = getContainers().registerContainer((DockerStorageContainer) StorageContainerFactory.newInstance(databaseType,
+                    testParam.getStorageContainerImage(), DatabaseTypedSPILoader.findService(StorageContainerConfigurationOption.class, databaseType).orElse(null), testParam.getScenario()));
         } else {
             storageContainer = getContainers().registerContainer(new NativeStorageContainer(databaseType, testParam.getScenario()));
         }
diff --git a/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/sql/env/container/compose/mode/ClusterContainerComposer.java b/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/sql/env/container/compose/mode/ClusterContainerComposer.java
diff --git a/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/sql/env/container/compose/mode/StandaloneContainerComposer.java b/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/sql/env/container/compose/mode/StandaloneContainerComposer.java

Original file line number	Diff line number	Diff line change
`@@ -84,4 +84,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {`
`84`	`84`	`public long getStartupTimeoutSeconds() {`
`85`	`85`	`return 180L;`
`86`	`86`	`}`
	`87`	`+`
	`88`	`+ @Override`
	`89`	`+ public String getDatabaseType() {`
	`90`	`+ return "Hive";`
	`91`	`+ }`
`87`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,4 +90,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {`
`90`	`90`	`public long getStartupTimeoutSeconds() {`
`91`	`91`	`return 120L;`
`92`	`92`	`}`
	`93`	`+`
	`94`	`+ @Override`
	`95`	`+ public String getDatabaseType() {`
	`96`	`+ return "MySQL";`
	`97`	`+ }`
`93`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,4 +81,9 @@ public Optional<String> getDefaultDatabaseName(final int majorVersion) {`
`81`	`81`	`public long getStartupTimeoutSeconds() {`
`82`	`82`	`return 120L;`
`83`	`83`	`}`
	`84`	`+`
	`85`	`+ @Override`
	`86`	`+ public String getDatabaseType() {`
	`87`	`+ return "openGauss";`
	`88`	`+ }`
`84`	`89`	`}`