Adjust algorithm parameters in RQL type DistSQL to json format (#29104)

* Adjust algorithm parameters in RQL type DistSQL to json format * Fix checkstyle error * Fix e2e test error
apache · Nov 21, 2023 · 46fc668 · 46fc668
1 parent 6231220
commit 46fc668
Show file tree

Hide file tree

Showing 19 changed files with 41 additions and 26 deletions.
diff --git a/...rg/apache/shardingsphere/sharding/distsql/handler/query/ShowShardingAuditorsExecutor.java b/...rg/apache/shardingsphere/sharding/distsql/handler/query/ShowShardingAuditorsExecutor.java
@@ -21,6 +21,7 @@
 import org.apache.shardingsphere.infra.config.algorithm.AlgorithmConfiguration;
 import org.apache.shardingsphere.infra.merge.result.impl.local.LocalDataQueryResultRow;
 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
+import org.apache.shardingsphere.infra.props.PropertiesConverter;
 import org.apache.shardingsphere.sharding.api.config.ShardingRuleConfiguration;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowShardingAuditorsStatement;
 import org.apache.shardingsphere.sharding.rule.ShardingRule;
@@ -46,7 +47,7 @@ public Collection<LocalDataQueryResultRow> getRows(final ShardingSphereDatabase
         Collection<LocalDataQueryResultRow> result = new LinkedList<>();
         while (data.hasNext()) {
             Entry<String, AlgorithmConfiguration> entry = data.next();
-            result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), entry.getValue().getProps()));
+            result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), PropertiesConverter.convert(entry.getValue().getProps())));
         }
         return result;
     }

diff --git a/...pache/shardingsphere/sharding/distsql/handler/query/ShowShardingKeyGeneratorExecutor.java b/...pache/shardingsphere/sharding/distsql/handler/query/ShowShardingKeyGeneratorExecutor.java
@@ -21,6 +21,7 @@
 import org.apache.shardingsphere.infra.config.algorithm.AlgorithmConfiguration;
 import org.apache.shardingsphere.infra.merge.result.impl.local.LocalDataQueryResultRow;
 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
+import org.apache.shardingsphere.infra.props.PropertiesConverter;
 import org.apache.shardingsphere.sharding.api.config.ShardingRuleConfiguration;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowShardingKeyGeneratorsStatement;
 import org.apache.shardingsphere.sharding.rule.ShardingRule;
@@ -48,7 +49,7 @@ public Collection<LocalDataQueryResultRow> getRows(final ShardingSphereDatabase
         Collection<LocalDataQueryResultRow> result = new LinkedList<>();
         while (data.hasNext()) {
             Entry<String, AlgorithmConfiguration> entry = data.next();
-            result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), entry.getValue().getProps().toString()));
+            result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), PropertiesConverter.convert(entry.getValue().getProps())));
         }
         return result;
     }

diff --git a/...che/shardingsphere/sharding/distsql/handler/query/ShowUnusedShardingAuditorsExecutor.java b/...che/shardingsphere/sharding/distsql/handler/query/ShowUnusedShardingAuditorsExecutor.java
@@ -21,6 +21,7 @@
 import org.apache.shardingsphere.infra.config.algorithm.AlgorithmConfiguration;
 import org.apache.shardingsphere.infra.merge.result.impl.local.LocalDataQueryResultRow;
 import org.apache.shardingsphere.infra.metadata.database.ShardingSphereDatabase;
+import org.apache.shardingsphere.infra.props.PropertiesConverter;
 import org.apache.shardingsphere.sharding.api.config.ShardingRuleConfiguration;
 import org.apache.shardingsphere.sharding.api.config.strategy.audit.ShardingAuditStrategyConfiguration;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowUnusedShardingAuditorsStatement;
@@ -50,7 +51,7 @@ public Collection<LocalDataQueryResultRow> getRows(final ShardingSphereDatabase
         Collection<LocalDataQueryResultRow> result = new LinkedList<>();
         for (Entry<String, AlgorithmConfiguration> entry : shardingRuleConfig.getAuditors().entrySet()) {
             if (!inUsedAuditors.contains(entry.getKey())) {
-                result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), entry.getValue().getProps().toString()));
+                result.add(new LocalDataQueryResultRow(entry.getKey(), entry.getValue().getType(), PropertiesConverter.convert(entry.getValue().getProps())));
             }
         }
         return result;

diff --git a/...va/org/apache/shardingsphere/sharding/distsql/query/ShowShardingAuditorsExecutorTest.java b/...va/org/apache/shardingsphere/sharding/distsql/query/ShowShardingAuditorsExecutorTest.java
@@ -26,12 +26,13 @@
 import org.apache.shardingsphere.sharding.distsql.handler.query.ShowShardingAuditorsExecutor;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowShardingAuditorsStatement;
 import org.apache.shardingsphere.sharding.rule.ShardingRule;
+import org.apache.shardingsphere.test.util.PropertiesBuilder;
+import org.apache.shardingsphere.test.util.PropertiesBuilder.Property;
 import org.junit.jupiter.api.Test;
 
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Iterator;
-import java.util.Properties;
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -54,7 +55,7 @@ void assertGetRowData() {
         LocalDataQueryResultRow row = iterator.next();
         assertThat(row.getCell(1), is("sharding_key_required_auditor"));
         assertThat(row.getCell(2), is("DML_SHARDING_CONDITIONS"));
-        assertThat(row.getCell(3).toString(), is("{}"));
+        assertThat(row.getCell(3).toString(), is("{\"key\":\"value\"}"));
     }
 
     @Test
@@ -70,7 +71,7 @@ void assertGetColumnNames() {
 
     private ShardingRuleConfiguration createRuleConfiguration() {
         ShardingRuleConfiguration result = new ShardingRuleConfiguration();
-        result.getAuditors().put("sharding_key_required_auditor", new AlgorithmConfiguration("DML_SHARDING_CONDITIONS", new Properties()));
+        result.getAuditors().put("sharding_key_required_auditor", new AlgorithmConfiguration("DML_SHARDING_CONDITIONS", PropertiesBuilder.build(new Property("key", "value"))));
         return result;
     }
 }
diff --git a/...rg/apache/shardingsphere/sharding/distsql/query/ShowShardingKeyGeneratorExecutorTest.java b/...rg/apache/shardingsphere/sharding/distsql/query/ShowShardingKeyGeneratorExecutorTest.java
@@ -26,12 +26,13 @@
 import org.apache.shardingsphere.sharding.distsql.handler.query.ShowShardingKeyGeneratorExecutor;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowShardingKeyGeneratorsStatement;
 import org.apache.shardingsphere.sharding.rule.ShardingRule;
+import org.apache.shardingsphere.test.util.PropertiesBuilder;
+import org.apache.shardingsphere.test.util.PropertiesBuilder.Property;
 import org.junit.jupiter.api.Test;
 
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Iterator;
-import java.util.Properties;
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -55,7 +56,7 @@ void assertGetRowData() {
         LocalDataQueryResultRow row = iterator.next();
         assertThat(row.getCell(1), is("snowflake"));
         assertThat(row.getCell(2), is("SNOWFLAKE"));
-        assertThat(row.getCell(3), is("{}"));
+        assertThat(row.getCell(3), is("{\"key\":\"value\"}"));
     }
 
     @Test
@@ -72,7 +73,7 @@ void assertGetColumnNames() {
 
     private ShardingRuleConfiguration createRuleConfiguration() {
         ShardingRuleConfiguration result = new ShardingRuleConfiguration();
-        result.getKeyGenerators().put("snowflake", new AlgorithmConfiguration("SNOWFLAKE", new Properties()));
+        result.getKeyGenerators().put("snowflake", new AlgorithmConfiguration("SNOWFLAKE", PropertiesBuilder.build(new Property("key", "value"))));
         return result;
     }
 }
diff --git a/.../apache/shardingsphere/sharding/distsql/query/ShowUnusedShardingAuditorsExecutorTest.java b/.../apache/shardingsphere/sharding/distsql/query/ShowUnusedShardingAuditorsExecutorTest.java
@@ -29,6 +29,8 @@
 import org.apache.shardingsphere.sharding.distsql.handler.query.ShowUnusedShardingAuditorsExecutor;
 import org.apache.shardingsphere.sharding.distsql.statement.ShowUnusedShardingAuditorsStatement;
 import org.apache.shardingsphere.sharding.rule.ShardingRule;
+import org.apache.shardingsphere.test.util.PropertiesBuilder;
+import org.apache.shardingsphere.test.util.PropertiesBuilder.Property;
 import org.junit.jupiter.api.Test;
 
 import java.util.Collection;
@@ -53,7 +55,7 @@ void assertGetRowData() {
         LocalDataQueryResultRow row = iterator.next();
         assertThat(row.getCell(1), is("fixture"));
         assertThat(row.getCell(2), is("FIXTURE"));
-        assertThat(row.getCell(3), is("{}"));
+        assertThat(row.getCell(3), is("{\"key\":\"value\"}"));
     }
 
     @Test
@@ -78,7 +80,7 @@ private ShardingSphereDatabase mockDatabase() {
     private RuleConfiguration createRuleConfiguration() {
         ShardingRuleConfiguration result = new ShardingRuleConfiguration();
         result.getAuditors().put("sharding_key_required_auditor", new AlgorithmConfiguration("DML_SHARDING_CONDITIONS", new Properties()));
-        result.getAuditors().put("fixture", new AlgorithmConfiguration("FIXTURE", null));
+        result.getAuditors().put("fixture", new AlgorithmConfiguration("FIXTURE", PropertiesBuilder.build(new Property("key", "value"))));
         result.getAutoTables().add(createShardingAutoTableRuleConfiguration());
         return result;
     }

diff --git a/infra/common/src/main/java/org/apache/shardingsphere/infra/props/PropertiesConverter.java b/infra/common/src/main/java/org/apache/shardingsphere/infra/props/PropertiesConverter.java
@@ -38,6 +38,9 @@ public final class PropertiesConverter {
      * @return converted string content
      */
     public static String convert(final Properties props) {
+        if (null == props) {
+            return "";
+        }
         Map<Object, Object> sortedProps = new LinkedHashMap<>();
         props.keySet().stream().map(Object::toString).sorted().forEach(each -> sortedProps.put(each, props.get(each)));
         return sortedProps.isEmpty() ? "" : JsonUtils.toJsonString(sortedProps);

diff --git a/.../apache/shardingsphere/globalclock/distsql/handler/query/ShowGlobalClockRuleExecutor.java b/.../apache/shardingsphere/globalclock/distsql/handler/query/ShowGlobalClockRuleExecutor.java
@@ -23,6 +23,7 @@
 import org.apache.shardingsphere.infra.merge.result.impl.local.LocalDataQueryResultRow;
 import org.apache.shardingsphere.infra.metadata.ShardingSphereMetaData;
 import org.apache.shardingsphere.globalclock.distsql.statement.queryable.ShowGlobalClockRuleStatement;
+import org.apache.shardingsphere.infra.props.PropertiesConverter;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -36,7 +37,8 @@ public final class ShowGlobalClockRuleExecutor implements MetaDataRequiredQuerya
     @Override
     public Collection<LocalDataQueryResultRow> getRows(final ShardingSphereMetaData metaData, final ShowGlobalClockRuleStatement sqlStatement) {
         GlobalClockRuleConfiguration ruleConfig = metaData.getGlobalRuleMetaData().getSingleRule(GlobalClockRule.class).getConfiguration();
-        return Collections.singleton(new LocalDataQueryResultRow(ruleConfig.getType(), ruleConfig.getProvider(), String.valueOf(ruleConfig.isEnabled()), ruleConfig.getProps().toString()));
+        return Collections.singleton(new LocalDataQueryResultRow(ruleConfig.getType(), ruleConfig.getProvider(),
+                String.valueOf(ruleConfig.isEnabled()), PropertiesConverter.convert(ruleConfig.getProps())));
     }
 
     @Override

diff --git a/...che/shardingsphere/globalclock/distsql/handler/query/ShowGlobalClockRuleExecutorTest.java b/...che/shardingsphere/globalclock/distsql/handler/query/ShowGlobalClockRuleExecutorTest.java
@@ -17,14 +17,16 @@
 
 package org.apache.shardingsphere.globalclock.distsql.handler.query;
 
+import org.apache.shardingsphere.globalclock.api.config.GlobalClockRuleConfiguration;
 import org.apache.shardingsphere.globalclock.core.rule.GlobalClockRule;
-import org.apache.shardingsphere.globalclock.core.rule.builder.DefaultGlobalClockRuleConfigurationBuilder;
+import org.apache.shardingsphere.globalclock.distsql.statement.queryable.ShowGlobalClockRuleStatement;
 import org.apache.shardingsphere.infra.config.props.ConfigurationProperties;
 import org.apache.shardingsphere.infra.merge.result.impl.local.LocalDataQueryResultRow;
 import org.apache.shardingsphere.infra.metadata.ShardingSphereMetaData;
 import org.apache.shardingsphere.infra.metadata.database.resource.ResourceMetaData;
 import org.apache.shardingsphere.infra.metadata.database.rule.RuleMetaData;
-import org.apache.shardingsphere.globalclock.distsql.statement.queryable.ShowGlobalClockRuleStatement;
+import org.apache.shardingsphere.test.util.PropertiesBuilder;
+import org.apache.shardingsphere.test.util.PropertiesBuilder.Property;
 import org.junit.jupiter.api.Test;
 
 import java.util.Collection;
@@ -51,7 +53,7 @@ void assertGlobalClockRule() {
         assertThat(row.getCell(1), is("TSO"));
         assertThat(row.getCell(2), is("local"));
         assertThat(row.getCell(3), is("false"));
-        assertThat(row.getCell(4), is("{}"));
+        assertThat(row.getCell(4), is("{\"key\":\"value\"}"));
     }
 
     @Test
@@ -68,7 +70,8 @@ void assertGetColumnNames() {
 
     private ShardingSphereMetaData mockMetaData() {
         GlobalClockRule sqlParserRule = mock(GlobalClockRule.class);
-        when(sqlParserRule.getConfiguration()).thenReturn(new DefaultGlobalClockRuleConfigurationBuilder().build());
+        GlobalClockRuleConfiguration globalClockRuleConfig = new GlobalClockRuleConfiguration("TSO", "local", false, PropertiesBuilder.build(new Property("key", "value")));
+        when(sqlParserRule.getConfiguration()).thenReturn(globalClockRuleConfig);
         return new ShardingSphereMetaData(new LinkedHashMap<>(), mock(ResourceMetaData.class),
                 new RuleMetaData(Collections.singleton(sqlParserRule)), new ConfigurationProperties(new Properties()));
     }

diff --git a/test/e2e/sql/src/test/resources/cases/rql/dataset/db/show_sharding_auditors.xml b/test/e2e/sql/src/test/resources/cases/rql/dataset/db/show_sharding_auditors.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auditor_constant| IT.AUDITOR.FIXTURE| {}" />
+    <row values="auditor_constant| IT.AUDITOR.FIXTURE| " />
 </dataset>
diff --git a/test/e2e/sql/src/test/resources/cases/rql/dataset/db/show_sharding_generators.xml b/test/e2e/sql/src/test/resources/cases/rql/dataset/db/show_sharding_generators.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| {}" />
+    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| " />
 </dataset>
diff --git a/...est/resources/cases/rql/dataset/dbtbl_with_readwrite_splitting/show_sharding_auditors.xml b/...est/resources/cases/rql/dataset/dbtbl_with_readwrite_splitting/show_sharding_auditors.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auditor_constant| IT.AUDITOR.FIXTURE| {}" />
+    <row values="auditor_constant| IT.AUDITOR.FIXTURE| " />
 </dataset>
diff --git a/...t/resources/cases/rql/dataset/dbtbl_with_readwrite_splitting/show_sharding_generators.xml b/...t/resources/cases/rql/dataset/dbtbl_with_readwrite_splitting/show_sharding_generators.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| {}" />
+    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| " />
 </dataset>
diff --git a/...s/cases/rql/dataset/dbtbl_with_readwrite_splitting_and_encrypt/show_sharding_auditors.xml b/...s/cases/rql/dataset/dbtbl_with_readwrite_splitting_and_encrypt/show_sharding_auditors.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auditor_constant| IT.AUDITOR.FIXTURE| {}" />
+    <row values="auditor_constant| IT.AUDITOR.FIXTURE| " />
 </dataset>
diff --git a/...cases/rql/dataset/dbtbl_with_readwrite_splitting_and_encrypt/show_sharding_generators.xml b/...cases/rql/dataset/dbtbl_with_readwrite_splitting_and_encrypt/show_sharding_generators.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="constant| IT.FIXTURE| {}" />
+    <row values="constant| IT.FIXTURE| " />
 </dataset>
diff --git a/.../sql/src/test/resources/cases/rql/dataset/sharding_and_encrypt/show_sharding_auditors.xml b/.../sql/src/test/resources/cases/rql/dataset/sharding_and_encrypt/show_sharding_auditors.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auditor_constant| IT.AUDITOR.FIXTURE| {}" />
+    <row values="auditor_constant| IT.AUDITOR.FIXTURE| " />
 </dataset>
diff --git a/...ql/src/test/resources/cases/rql/dataset/sharding_and_encrypt/show_sharding_generators.xml b/...ql/src/test/resources/cases/rql/dataset/sharding_and_encrypt/show_sharding_generators.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="constant| IT.FIXTURE| {}" />
+    <row values="constant| IT.FIXTURE| " />
 </dataset>
diff --git a/test/e2e/sql/src/test/resources/cases/rql/dataset/tbl/show_sharding_auditors.xml b/test/e2e/sql/src/test/resources/cases/rql/dataset/tbl/show_sharding_auditors.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auditor_constant| IT.AUDITOR.FIXTURE| {}" />
+    <row values="auditor_constant| IT.AUDITOR.FIXTURE| " />
 </dataset>
diff --git a/test/e2e/sql/src/test/resources/cases/rql/dataset/tbl/show_sharding_generators.xml b/test/e2e/sql/src/test/resources/cases/rql/dataset/tbl/show_sharding_generators.xml
@@ -21,5 +21,5 @@
         <column name="type" />
         <column name="props" />
     </metadata>
-    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| {}" />
+    <row values="auto_increment| IT.AUTO_INCREMENT.FIXTURE| " />
 </dataset>