You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2026/06/18 11:11:32 UTC
(shardingsphere) branch master updated: Harden generated DistSQL validation (#38865)
This is an automated email from the ASF dual-hosted git repository.
terrymanu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new a54f1aaf96c Harden generated DistSQL validation (#38865)
a54f1aaf96c is described below
commit a54f1aaf96c74396ffbccd8bdfb9a960991d80fa
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Thu Jun 18 19:11:26 2026 +0800
Harden generated DistSQL validation (#38865)
* Harden generated DistSQL validation
- clarify execute-update preview as classification-only
- block known invalid generated encrypt rule DistSQL before approval
- fix encrypt descriptor AES DistSQL examples and validation
- add regression coverage for reserved identifiers and required algorithm properties
* Harden generated DistSQL validation
- clarify execute-update preview as classification-only
- block known invalid generated encrypt rule DistSQL before approval
- fix encrypt descriptor AES DistSQL examples and validation
- add regression coverage for reserved identifiers and required algorithm properties
* Harden generated DistSQL validation
- clarify execute-update preview as classification-only
- block known invalid generated encrypt rule DistSQL before approval
- fix encrypt descriptor AES DistSQL examples and validation
- add regression coverage for reserved identifiers and required algorithm properties
---
.../handler/execute/ExecuteUpdateToolHandler.java | 10 ++-
.../workflow/WorkflowExecutionToolHandler.java | 6 +-
.../core/workflow/WorkflowExecutionService.java | 46 ++++++++++++
.../WorkflowRuntimeDefinitionRegistry.java | 2 +
.../mcp-descriptors/mcp-descriptor-core.yaml | 5 +-
.../execute/ExecuteUpdateToolHandlerTest.java | 19 +++--
.../workflow/WorkflowExecutionToolHandlerTest.java | 8 +-
.../workflow/WorkflowHandlerTestFixture.java | 7 ++
.../workflow/WorkflowExecutionServiceTest.java | 29 ++++++++
.../WorkflowRuntimeDefinitionRegistryTest.java | 7 ++
.../BroadcastRuleDistSQLPlanningServiceTest.java | 6 ++
.../descriptor/EncryptToolDescriptorValidator.java | 48 ++++++++++++
.../service/EncryptWorkflowValidationService.java | 49 ++++++++++++-
.../mcp-descriptors/mcp-descriptor-encrypt.yaml | 8 +-
.../encrypt/EncryptMCPHandlerProviderTest.java | 1 +
.../EncryptToolDescriptorValidatorTest.java | 30 ++++++++
.../EncryptRuleDistSQLPlanningServiceTest.java | 85 ++++++++++++++--------
.../EncryptWorkflowPlanningServiceTest.java | 19 +++++
.../EncryptWorkflowValidationServiceTest.java | 36 +++++++++
.../MaskAlgorithmPropertyTemplateServiceTest.java | 7 ++
.../MaskRuleDistSQLPlanningServiceTest.java | 10 +++
...ittingAlgorithmPropertyTemplateServiceTest.java | 10 +++
...adwriteSplittingDistSQLPlanningServiceTest.java | 13 ++++
.../service/ShadowDistSQLPlanningServiceTest.java | 12 +++
...ardingAlgorithmPropertyTemplateServiceTest.java | 13 ++++
.../ShardingDistSQLPlanningServiceTest.java | 13 ++++
...java => MCPWorkflowApplyArtifactValidator.java} | 33 ++++-----
.../workflow/spi/WorkflowRuntimeDefinition.java | 38 +++++++++-
.../workflow/service/WorkflowSQLUtilsTest.java | 6 ++
.../spi/WorkflowRuntimeDefinitionTest.java | 42 +++++++++++
.../model-contract/capabilities.yaml | 4 +-
31 files changed, 550 insertions(+), 72 deletions(-)
diff --git a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandler.java b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandler.java
index 77c8b650fac..461cbf313a4 100644
--- a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandler.java
+++ b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandler.java
@@ -51,6 +51,11 @@ public final class ExecuteUpdateToolHandler implements MCPToolHandler<MCPDatabas
private static final String RESULT_KIND_PREVIEW = "preview";
+ private static final String PREVIEW_REVIEW_GUIDANCE = "Review normalized_sql and side_effect_scope before execution. "
+ + "This preview is classification-only; it does not guarantee parsing, rule validation, algorithm initialization, affected rows, or runtime success.";
+
+ private static final String PREVIEW_EXECUTION_REASON = "Execute only after reviewing normalized_sql and side_effect_scope; preview did not validate runtime executability.";
+
@Override
public Class<MCPDatabaseHandlerContext> getContextType() {
return MCPDatabaseHandlerContext.class;
@@ -110,14 +115,13 @@ public final class ExecuteUpdateToolHandler implements MCPToolHandler<MCPDatabas
result.put("side_effect_scope", createSideEffectScope(classificationResult));
classificationResult.getTargetObjectName().ifPresent(optional -> result.put("target_object", optional));
classificationResult.getSavepointName().ifPresent(optional -> result.put("savepoint", optional));
- result.put("review_guidance", "Review normalized_sql and side_effect_scope before calling database_gateway_execute_update with execution_mode=execute.");
+ result.put("review_guidance", PREVIEW_REVIEW_GUIDANCE);
result.put("review_summary", createReviewSummary(classificationResult));
Map<String, Object> suggestedArguments = createSuggestedArguments(toolArguments, classificationResult);
result.put("suggested_arguments", suggestedArguments);
result.put(MCPPayloadFieldNames.RESOURCES_TO_READ, createResourcesToRead(toolArguments));
result.put("argument_provenance", createArgumentProvenance(suggestedArguments));
- result.put(MCPPayloadFieldNames.NEXT_ACTIONS, List.of(MCPNextActionUtils.callTool(TOOL_NAME,
- "Execute after reviewing normalized_sql and side_effect_scope.", suggestedArguments)));
+ result.put(MCPPayloadFieldNames.NEXT_ACTIONS, List.of(MCPNextActionUtils.callTool(TOOL_NAME, PREVIEW_EXECUTION_REASON, suggestedArguments)));
return new MCPMapResponse(result);
}
diff --git a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandler.java b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandler.java
index 3989bf22231..d6ab871a735 100644
--- a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandler.java
+++ b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandler.java
@@ -33,6 +33,7 @@ import org.apache.shardingsphere.mcp.support.workflow.descriptor.WorkflowToolDes
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowFieldNames;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
+import org.apache.shardingsphere.mcp.support.workflow.spi.WorkflowRuntimeDefinition;
import java.util.LinkedHashMap;
import java.util.List;
@@ -74,9 +75,10 @@ public final class WorkflowExecutionToolHandler implements MCPToolHandler<MCPWor
WorkflowContextSnapshot snapshot = WorkflowSessionSnapshotResolver.getRequired(workflowContext.getWorkflowSessionContext(), toolCall.getSessionId(),
toolArguments.getStringArgument(WorkflowFieldNames.PLAN_ID));
WorkflowKind workflowKind = getRequiredWorkflowKind(snapshot);
+ WorkflowRuntimeDefinition workflowRuntimeDefinition = workflowRuntimeDefinitionRegistry.getRequired(workflowKind);
return new MCPMapResponse(executionService.apply(workflowContext.getWorkflowSessionContext(), databaseContext.getMetadataQueryFacade(), databaseContext.getQueryFacade(),
- databaseContext.getExecutionFacade(), workflowRuntimeDefinitionRegistry.getRequired(workflowKind).getApplySynchronizationHandler(), toolCall.getSessionId(), snapshot,
- toolArguments.getStringCollectionArgument("approved_steps"), executionMode));
+ databaseContext.getExecutionFacade(), workflowRuntimeDefinition.getApplySynchronizationHandler(), workflowRuntimeDefinition.getApplyArtifactValidator(), toolCall.getSessionId(),
+ snapshot, toolArguments.getStringCollectionArgument("approved_steps"), executionMode));
}
private WorkflowKind getRequiredWorkflowKind(final WorkflowContextSnapshot snapshot) {
diff --git a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionService.java b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionService.java
index a14b3503d5e..30f4b622eaf 100644
--- a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionService.java
+++ b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionService.java
@@ -42,6 +42,7 @@ import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowGuidancePa
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowLifecycleUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSecretReferenceUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSynchronizationException;
+import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplyArtifactValidator;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplySynchronizationHandler;
import java.util.Collection;
@@ -82,12 +83,39 @@ public final class WorkflowExecutionService {
public Map<String, Object> apply(final WorkflowSessionContext workflowSessionContext, final MCPMetadataQueryFacade metadataQueryFacade, final MCPFeatureQueryFacade queryFacade,
final MCPFeatureExecutionFacade executionFacade, final MCPWorkflowApplySynchronizationHandler workflowApplySynchronizationHandler,
final String sessionId, final WorkflowContextSnapshot snapshot, final List<String> approvedSteps, final String executionMode) {
+ return apply(workflowSessionContext, metadataQueryFacade, queryFacade, executionFacade, workflowApplySynchronizationHandler, MCPWorkflowApplyArtifactValidator.NO_OP,
+ sessionId, snapshot, approvedSteps, executionMode);
+ }
+
+ /**
+ * Apply workflow artifacts.
+ *
+ * @param workflowSessionContext workflow session context
+ * @param metadataQueryFacade metadata query facade
+ * @param queryFacade query facade
+ * @param executionFacade execution facade
+ * @param workflowApplySynchronizationHandler workflow apply synchronization handler
+ * @param workflowApplyArtifactValidator workflow apply artifact validator
+ * @param sessionId session id
+ * @param snapshot workflow snapshot
+ * @param approvedSteps approved steps
+ * @param executionMode execution mode override
+ * @return apply payload
+ */
+ public Map<String, Object> apply(final WorkflowSessionContext workflowSessionContext, final MCPMetadataQueryFacade metadataQueryFacade, final MCPFeatureQueryFacade queryFacade,
+ final MCPFeatureExecutionFacade executionFacade, final MCPWorkflowApplySynchronizationHandler workflowApplySynchronizationHandler,
+ final MCPWorkflowApplyArtifactValidator workflowApplyArtifactValidator, final String sessionId, final WorkflowContextSnapshot snapshot,
+ final List<String> approvedSteps, final String executionMode) {
String actualExecutionMode = requireExecutionMode(snapshot, executionMode);
requireApprovedSteps(snapshot, approvedSteps);
Map<String, Object> rejectedResponse = checkApplyPreconditions(sessionId, snapshot, actualExecutionMode, approvedSteps);
if (!rejectedResponse.isEmpty()) {
return rejectedResponse;
}
+ Map<String, Object> invalidArtifactResponse = validateApplyArtifacts(workflowSessionContext, snapshot, actualExecutionMode, workflowApplyArtifactValidator);
+ if (!invalidArtifactResponse.isEmpty()) {
+ return invalidArtifactResponse;
+ }
WorkflowApplyOutcome applyOutcome = new WorkflowApplyOutcome();
if (EXECUTION_MODE_PREVIEW.equalsIgnoreCase(actualExecutionMode)) {
return previewApply(workflowSessionContext, snapshot);
@@ -186,6 +214,24 @@ public final class WorkflowExecutionService {
return visibleSteps.containsAll(approvedSteps);
}
+ private Map<String, Object> validateApplyArtifacts(final WorkflowSessionContext workflowSessionContext, final WorkflowContextSnapshot snapshot,
+ final String executionMode, final MCPWorkflowApplyArtifactValidator workflowApplyArtifactValidator) {
+ List<Map<String, Object>> validationIssues = workflowApplyArtifactValidator.validate(snapshot, createExecutableArtifacts(snapshot));
+ if (!validationIssues.isEmpty()) {
+ persistSnapshot(workflowSessionContext, snapshot, WorkflowLifecycle.STEP_FAILED, WorkflowLifecycle.STATUS_FAILED);
+ Map<String, Object> result = createResponse(snapshot, WorkflowLifecycle.STATUS_FAILED, executionMode, validationIssues,
+ List.of(), List.of(), List.of(), List.of(), Map.of());
+ if (EXECUTION_MODE_PREVIEW.equalsIgnoreCase(executionMode)) {
+ result.put("would_apply", false);
+ result.put("preview_artifacts", List.of());
+ }
+ result.put("review_summary", "Workflow apply blocked invalid generated artifacts before approval.");
+ result.put(MCPPayloadFieldNames.NEXT_ACTIONS, MCPNextActionUtils.ordered(MCPNextActionUtils.stop("Fix generated workflow artifacts, then preview the workflow again.")));
+ return result;
+ }
+ return Map.of();
+ }
+
private Map<String, Object> previewApply(final WorkflowSessionContext workflowSessionContext, final WorkflowContextSnapshot snapshot) {
persistSnapshot(workflowSessionContext, snapshot, WorkflowLifecycle.STEP_REVIEW, WorkflowLifecycle.STATUS_PREVIEWED);
List<Map<String, Object>> previewArtifacts = createPreviewArtifacts(snapshot);
diff --git a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistry.java b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistry.java
index 327168cdbe2..d67f8ffc330 100644
--- a/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistry.java
+++ b/mcp/core/src/main/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistry.java
@@ -53,6 +53,8 @@ public final class WorkflowRuntimeDefinitionRegistry {
() -> new IllegalArgumentException(String.format("Workflow validation handler is required for `%s`.", workflowKind.getValue())));
ShardingSpherePreconditions.checkNotNull(each.getApplySynchronizationHandler(),
() -> new IllegalArgumentException(String.format("Workflow apply synchronization handler is required for `%s`.", workflowKind.getValue())));
+ ShardingSpherePreconditions.checkNotNull(each.getApplyArtifactValidator(),
+ () -> new IllegalArgumentException(String.format("Workflow apply artifact validator is required for `%s`.", workflowKind.getValue())));
WorkflowRuntimeDefinition previousDefinition = result.putIfAbsent(workflowKind, each);
ShardingSpherePreconditions.checkState(null == previousDefinition,
() -> new IllegalArgumentException(String.format("Duplicate workflow kind `%s` with `%s` and `%s`.",
diff --git a/mcp/core/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-core.yaml b/mcp/core/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-core.yaml
index 39b82cd33e1..fe18ec4d64d 100644
--- a/mcp/core/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-core.yaml
+++ b/mcp/core/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-core.yaml
@@ -1293,7 +1293,7 @@ tools:
description: "Execution mode used by the call; preview means the statement was not executed."
preview_semantics:
type: string
- description: "Preview meaning. classification_only means the server classified SQL and side-effect scope without estimating affected rows."
+ description: "Preview meaning. classification_only means the server classified SQL and side-effect scope without parsing, rule validation, algorithm initialization, affected-row estimation, or runtime execution."
enum:
- classification_only
status:
@@ -1399,6 +1399,7 @@ tools:
status: PREVIEWED
would_execute: false
affected_rows_estimated: false
+ review_guidance: Review normalized_sql and side_effect_scope before execution. This preview is classification-only; it does not guarantee parsing, rule validation, algorithm initialization, affected rows, or runtime success.
review_summary: Previewed UPDATE statement with side-effect scope physical-data. It has not been executed.
suggested_arguments:
execution_mode: execute
@@ -1409,7 +1410,7 @@ tools:
tool_name: database_gateway_execute_update
arguments:
execution_mode: execute
- reason: Execute after reviewing normalized_sql and side_effect_scope.
+ reason: Execute only after reviewing normalized_sql and side_effect_scope; preview did not validate runtime executability.
annotations:
title: Execute Update SQL
readOnlyHint: false
diff --git a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandlerTest.java b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandlerTest.java
index 5fc68ed93a2..96605ab506c 100644
--- a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandlerTest.java
+++ b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/execute/ExecuteUpdateToolHandlerTest.java
@@ -114,6 +114,9 @@ class ExecuteUpdateToolHandlerTest {
assertThat(actual.toPayload().get("statement_class"), is("dml"));
assertThat(actual.toPayload().get("side_effect_scope"), is(List.of("physical-data")));
assertThat(actual.toPayload().get("review_summary"), is("Previewed UPDATE statement with side-effect scope physical-data. It has not been executed."));
+ assertThat(actual.toPayload().get("review_guidance"),
+ is("Review normalized_sql and side_effect_scope before execution. "
+ + "This preview is classification-only; it does not guarantee parsing, rule validation, algorithm initialization, affected rows, or runtime success."));
assertFalse(actual.toPayload().containsKey("suggested_next_tool"));
assertThat(((Map<?, ?>) actual.toPayload().get("suggested_arguments")).get("execution_mode"), is("execute"));
assertFalse(((Map<?, ?>) actual.toPayload().get("suggested_arguments")).containsKey("approved_by_user"));
@@ -122,13 +125,15 @@ class ExecuteUpdateToolHandlerTest {
assertFalse(((Map<?, ?>) actual.toPayload().get("argument_provenance")).containsKey("approved_by_user"));
List<?> actualNextActions = (List<?>) actual.toPayload().get("next_actions");
assertThat(actualNextActions.size(), is(1));
- assertThat(((Map<?, ?>) actualNextActions.get(0)).get("type"), is("tool_call"));
- assertThat(((Map<?, ?>) actualNextActions.get(0)).get("order"), is(1));
- assertThat(((Map<?, ?>) actualNextActions.get(0)).get("tool_name"), is("database_gateway_execute_update"));
- assertThat(((Map<?, ?>) ((Map<?, ?>) actualNextActions.get(0)).get("arguments")).get("execution_mode"), is("execute"));
- assertFalse(((Map<?, ?>) ((Map<?, ?>) actualNextActions.get(0)).get("arguments")).containsKey("approved_by_user"));
- assertFalse(((Map<?, ?>) actualNextActions.get(0)).containsKey("requires_user_approval"));
- assertThat(((Map<?, ?>) ((List<?>) actual.toPayload().get("resources_to_read")).get(0)).get("uri"), is("shardingsphere://databases/logic_db/capabilities"));
+ assertThat(((Map<?, ?>) actualNextActions.getFirst()).get("type"), is("tool_call"));
+ assertThat(((Map<?, ?>) actualNextActions.getFirst()).get("order"), is(1));
+ assertThat(((Map<?, ?>) actualNextActions.getFirst()).get("tool_name"), is("database_gateway_execute_update"));
+ assertThat(((Map<?, ?>) actualNextActions.getFirst()).get("reason"),
+ is("Execute only after reviewing normalized_sql and side_effect_scope; preview did not validate runtime executability."));
+ assertThat(((Map<?, ?>) ((Map<?, ?>) actualNextActions.getFirst()).get("arguments")).get("execution_mode"), is("execute"));
+ assertFalse(((Map<?, ?>) ((Map<?, ?>) actualNextActions.getFirst()).get("arguments")).containsKey("approved_by_user"));
+ assertFalse(((Map<?, ?>) actualNextActions.getFirst()).containsKey("requires_user_approval"));
+ assertThat(((Map<?, ?>) ((List<?>) actual.toPayload().get("resources_to_read")).getFirst()).get("uri"), is("shardingsphere://databases/logic_db/capabilities"));
assertFalse(actual.toPayload().containsKey("ask_user_when_uncertain"));
assertFalse(actual.toPayload().containsKey("recommended_next_call"));
verifyNoInteractions(executionFacade);
diff --git a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandlerTest.java b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandlerTest.java
index 57f809276e3..38948309aa2 100644
--- a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandlerTest.java
+++ b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowExecutionToolHandlerTest.java
@@ -25,6 +25,7 @@ import org.apache.shardingsphere.mcp.core.workflow.WorkflowExecutionService;
import org.apache.shardingsphere.mcp.core.workflow.WorkflowRuntimeDefinitionRegistry;
import org.apache.shardingsphere.mcp.support.descriptor.MCPDescriptorCatalogIndex;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
+import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplyArtifactValidator;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplySynchronizationHandler;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowValidationHandler;
import org.junit.jupiter.api.Test;
@@ -55,16 +56,17 @@ class WorkflowExecutionToolHandlerTest {
@Test
void assertHandleExecution() throws ReflectiveOperationException {
WorkflowExecutionService executionService = mock(WorkflowExecutionService.class);
- when(executionService.apply(any(), any(), any(), any(), any(), any(), any(), any(), any())).thenReturn(Map.of("status", "completed"));
+ when(executionService.apply(any(), any(), any(), any(), any(), any(), any(), any(), any(), any())).thenReturn(Map.of("status", "completed"));
WorkflowContextSnapshot snapshot = WorkflowHandlerTestFixture.createSnapshot();
WorkflowHandlerTestFixture.Context fixture = WorkflowHandlerTestFixture.createContext(snapshot);
MCPWorkflowApplySynchronizationHandler workflowApplySynchronizationHandler = mock(MCPWorkflowApplySynchronizationHandler.class);
+ MCPWorkflowApplyArtifactValidator workflowApplyArtifactValidator = mock(MCPWorkflowApplyArtifactValidator.class);
WorkflowExecutionToolHandler handler = createExecutionToolHandler(executionService, new WorkflowRuntimeDefinitionRegistry(List.of(
- WorkflowHandlerTestFixture.createDefinition("encrypt.rule", mock(MCPWorkflowValidationHandler.class), workflowApplySynchronizationHandler))));
+ WorkflowHandlerTestFixture.createDefinition("encrypt.rule", mock(MCPWorkflowValidationHandler.class), workflowApplySynchronizationHandler, workflowApplyArtifactValidator))));
MCPResponse actual = handler.handle(fixture.workflowContext(), new MCPToolCall("session-1",
Map.of("plan_id", "plan-1", "approved_steps", List.of("ddl"), "execution_mode", "manual-only")));
verify(executionService).apply(eq(fixture.workflowSessionContext()), eq(fixture.metadataQueryFacade()), eq(fixture.queryFacade()), eq(fixture.executionFacade()),
- eq(workflowApplySynchronizationHandler), eq("session-1"), eq(snapshot), eq(List.of("ddl")), eq("manual-only"));
+ eq(workflowApplySynchronizationHandler), eq(workflowApplyArtifactValidator), eq("session-1"), eq(snapshot), eq(List.of("ddl")), eq("manual-only"));
assertThat(actual.toPayload().get("status"), is("completed"));
}
diff --git a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowHandlerTestFixture.java b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowHandlerTestFixture.java
index 3097c5b9acd..a5264adbd2a 100644
--- a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowHandlerTestFixture.java
+++ b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/tool/handler/workflow/WorkflowHandlerTestFixture.java
@@ -25,6 +25,7 @@ import org.apache.shardingsphere.mcp.support.workflow.MCPWorkflowHandlerContext;
import org.apache.shardingsphere.mcp.support.workflow.WorkflowSessionContext;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
+import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplyArtifactValidator;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplySynchronizationHandler;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowValidationHandler;
import org.apache.shardingsphere.mcp.support.workflow.spi.WorkflowRuntimeDefinition;
@@ -79,6 +80,12 @@ final class WorkflowHandlerTestFixture {
return new WorkflowRuntimeDefinition(WorkflowKind.valueOf(workflowKind), validationHandler, applySynchronizationHandler);
}
+ static WorkflowRuntimeDefinition createDefinition(final String workflowKind, final MCPWorkflowValidationHandler validationHandler,
+ final MCPWorkflowApplySynchronizationHandler applySynchronizationHandler,
+ final MCPWorkflowApplyArtifactValidator applyArtifactValidator) {
+ return new WorkflowRuntimeDefinition(WorkflowKind.valueOf(workflowKind), validationHandler, applySynchronizationHandler, applyArtifactValidator);
+ }
+
record Context(MCPWorkflowHandlerContext workflowContext, WorkflowSessionContext workflowSessionContext,
MCPMetadataQueryFacade metadataQueryFacade, MCPFeatureQueryFacade queryFacade, MCPFeatureExecutionFacade executionFacade) {
}
diff --git a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionServiceTest.java b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionServiceTest.java
index 8a8ac9cfa23..02d7b0a3b74 100644
--- a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionServiceTest.java
+++ b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowExecutionServiceTest.java
@@ -31,6 +31,7 @@ import org.apache.shardingsphere.mcp.support.workflow.model.InteractionPlan;
import org.apache.shardingsphere.mcp.support.workflow.model.RuleArtifact;
import org.apache.shardingsphere.mcp.support.workflow.model.SecretReferenceValue;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
+import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowIssue;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowIssueCode;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowRequest;
@@ -314,6 +315,34 @@ class WorkflowExecutionServiceTest {
assertFalse(String.valueOf(actualResponse).contains("123456"));
}
+ @Test
+ void assertApplyPreviewBlocksArtifactValidatorIssues() {
+ WorkflowContextSnapshot snapshot = createSnapshot();
+ snapshot.setWorkflowKind(WorkflowKind.valueOf("mask.rule"));
+ snapshot.getRuleArtifacts().add(new RuleArtifact("create", "CREATE MASK RULE orders"));
+ WorkflowSessionContext workflowSessionContext = new InMemoryWorkflowSessionContext();
+ workflowSessionContext.save(snapshot);
+ MCPFeatureExecutionFacade executionFacade = mock(MCPFeatureExecutionFacade.class);
+ Map<String, Object> actualResponse = new WorkflowExecutionService().apply(workflowSessionContext, mock(MCPMetadataQueryFacade.class), mock(MCPFeatureQueryFacade.class),
+ executionFacade, MCPWorkflowApplySynchronizationHandler.NO_OP,
+ (workflowSnapshot, artifacts) -> List.of(new WorkflowIssue(WorkflowIssueCode.SQL_EXECUTABILITY_FAILED, "error", "review",
+ "Generated workflow artifact is invalid.", "Regenerate the workflow artifact before approval.", true,
+ Map.of("sql", artifacts.iterator().next().displaySql())).toMap()),
+ "session-1", snapshot, List.of(), "preview");
+ assertThat(actualResponse.get("status"), is("failed"));
+ assertThat(actualResponse.get("response_mode"), is("preview"));
+ assertFalse((Boolean) actualResponse.get("would_apply"));
+ assertThat(((List<?>) actualResponse.get("preview_artifacts")).size(), is(0));
+ assertThat(((List<?>) actualResponse.get("manual_artifacts")).size(), is(0));
+ assertThat(actualResponse.get("manual_artifact_package"), is(Map.of()));
+ assertThat(((List<?>) actualResponse.get("issues")).size(), is(1));
+ Map<?, ?> actualIssue = (Map<?, ?>) ((List<?>) actualResponse.get("issues")).getFirst();
+ assertThat(actualIssue.get("code"), is(WorkflowIssueCode.SQL_EXECUTABILITY_FAILED));
+ assertThat(actualIssue.get("message"), is("Generated workflow artifact is invalid."));
+ assertThat(workflowSessionContext.getRequired("plan-1").getStatus(), is("failed"));
+ verify(executionFacade, never()).execute(any());
+ }
+
@Test
void assertApplyPreviewForManualOnlyDoesNotRequireApprovalForExport() {
WorkflowContextSnapshot snapshot = createSnapshot();
diff --git a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistryTest.java b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistryTest.java
index 4fabd2c45c1..c53bba63c50 100644
--- a/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistryTest.java
+++ b/mcp/core/src/test/java/org/apache/shardingsphere/mcp/core/workflow/WorkflowRuntimeDefinitionRegistryTest.java
@@ -123,6 +123,13 @@ class WorkflowRuntimeDefinitionRegistryTest {
assertThat(actual.getMessage(), is("Workflow apply synchronization handler is required for `encrypt.rule`."));
}
+ @Test
+ void assertCreateRegistryWithNullApplyArtifactValidator() {
+ IllegalArgumentException actual = assertThrows(IllegalArgumentException.class, () -> new WorkflowRuntimeDefinitionRegistry(
+ List.of(new WorkflowRuntimeDefinition(WorkflowKind.valueOf("encrypt.rule"), mock(MCPWorkflowValidationHandler.class), mock(MCPWorkflowApplySynchronizationHandler.class), null))));
+ assertThat(actual.getMessage(), is("Workflow apply artifact validator is required for `encrypt.rule`."));
+ }
+
@Test
void assertCreateRegistryWithDuplicateWorkflowKind() {
WorkflowRuntimeDefinition firstDefinition = createDefinition("encrypt.rule");
diff --git a/mcp/features/broadcast/src/test/java/org/apache/shardingsphere/mcp/feature/broadcast/tool/service/BroadcastRuleDistSQLPlanningServiceTest.java b/mcp/features/broadcast/src/test/java/org/apache/shardingsphere/mcp/feature/broadcast/tool/service/BroadcastRuleDistSQLPlanningServiceTest.java
index 2f6e2fabf02..10dda02acb0 100644
--- a/mcp/features/broadcast/src/test/java/org/apache/shardingsphere/mcp/feature/broadcast/tool/service/BroadcastRuleDistSQLPlanningServiceTest.java
+++ b/mcp/features/broadcast/src/test/java/org/apache/shardingsphere/mcp/feature/broadcast/tool/service/BroadcastRuleDistSQLPlanningServiceTest.java
@@ -38,6 +38,12 @@ class BroadcastRuleDistSQLPlanningServiceTest {
assertThat(actual.getSql(), is("CREATE BROADCAST TABLE RULE t_order, `order`"));
}
+ @Test
+ void assertPlanCreateRuleFormatsReservedIdentifiers() {
+ RuleArtifact actual = service.planCreateRule(List.of("from", "table", "name"));
+ assertThat(actual.getSql(), is("CREATE BROADCAST TABLE RULE `from`, `table`, `name`"));
+ }
+
@Test
void assertPlanDropRule() {
RuleArtifact actual = service.planDropRule(List.of("t_order"));
diff --git a/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidator.java b/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidator.java
index f4dc0fe49ae..c2f6b82b561 100644
--- a/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidator.java
+++ b/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidator.java
@@ -24,7 +24,10 @@ import org.apache.shardingsphere.mcp.support.descriptor.MCPToolDescriptorValidat
import org.apache.shardingsphere.mcp.support.protocol.MCPPayloadFieldNames;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowFieldNames;
+import java.util.Collection;
import java.util.List;
+import java.util.Locale;
+import java.util.Map;
/**
* Encrypt tool descriptor validator.
@@ -45,5 +48,50 @@ public final class EncryptToolDescriptorValidator implements MCPToolDescriptorVa
@Override
public void validate(final MCPToolDescriptor toolDescriptor) {
MCPToolDescriptorValidationUtils.validateRequiredOutputFields(toolDescriptor, REQUIRED_OUTPUT_FIELDS);
+ validateExecutableDistSQLArtifacts(toolDescriptor);
+ }
+
+ private void validateExecutableDistSQLArtifacts(final MCPToolDescriptor toolDescriptor) {
+ Object examples = toolDescriptor.getOutputSchema().get("examples");
+ if (examples instanceof Collection) {
+ for (Object each : (Collection<?>) examples) {
+ validateExecutableDistSQLArtifact(toolDescriptor, each);
+ }
+ }
+ }
+
+ private void validateExecutableDistSQLArtifact(final MCPToolDescriptor toolDescriptor, final Object value) {
+ if (value instanceof Map) {
+ validateExecutableDistSQLArtifactMap(toolDescriptor, (Map<?, ?>) value);
+ } else if (value instanceof Collection) {
+ for (Object each : (Collection<?>) value) {
+ validateExecutableDistSQLArtifact(toolDescriptor, each);
+ }
+ }
+ }
+
+ private void validateExecutableDistSQLArtifactMap(final MCPToolDescriptor toolDescriptor, final Map<?, ?> value) {
+ Object sql = value.get("sql");
+ if (null != sql && isEncryptRuleDistSQL(sql.toString())) {
+ validateEncryptRuleDistSQL(toolDescriptor, sql.toString());
+ }
+ for (Object each : value.values()) {
+ validateExecutableDistSQLArtifact(toolDescriptor, each);
+ }
+ }
+
+ private boolean isEncryptRuleDistSQL(final String sql) {
+ String actualSQL = sql.toUpperCase(Locale.ENGLISH);
+ return actualSQL.contains("CREATE ENCRYPT RULE") || actualSQL.contains("ALTER ENCRYPT RULE");
+ }
+
+ private void validateEncryptRuleDistSQL(final MCPToolDescriptor toolDescriptor, final String sql) {
+ String actualSQL = sql.toLowerCase(Locale.ENGLISH);
+ if (actualSQL.contains("type(name=aes")) {
+ throw new IllegalStateException(String.format("Tool `%s` output example executable encrypt DistSQL must quote algorithm type as a string literal.", toolDescriptor.getName()));
+ }
+ if (actualSQL.contains("'aes-key-value'") && !actualSQL.contains("'digest-algorithm-name'")) {
+ throw new IllegalStateException(String.format("Tool `%s` output example executable AES DistSQL must include `digest-algorithm-name`.", toolDescriptor.getName()));
+ }
}
}
diff --git a/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationService.java b/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationService.java
index dc1bee54144..aadfb86d3c1 100644
--- a/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationService.java
+++ b/mcp/features/encrypt/src/main/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationService.java
@@ -28,27 +28,37 @@ import org.apache.shardingsphere.mcp.support.workflow.model.RuleWorkflowFeatureD
import org.apache.shardingsphere.mcp.support.workflow.model.ValidationReport;
import org.apache.shardingsphere.mcp.support.workflow.model.ValidationSection;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
+import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowIssue;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowIssueCode;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowLifecycle;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowArtifactMaskUtils;
+import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowArtifactBundle.ExecutableWorkflowArtifact;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowLifecycleUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowRuleValueUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSecretReferenceUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSQLUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSynchronizationSupport;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowValidationSupport;
+import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowApplyArtifactValidator;
import org.apache.shardingsphere.mcp.support.workflow.spi.MCPWorkflowRuntimeHandler;
+import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
+import java.util.Locale;
import java.util.Map;
import java.util.Optional;
+import java.util.regex.Pattern;
/**
* Encrypt workflow validation service.
*/
-public final class EncryptWorkflowValidationService implements MCPWorkflowRuntimeHandler {
+public final class EncryptWorkflowValidationService implements MCPWorkflowRuntimeHandler, MCPWorkflowApplyArtifactValidator {
+
+ private static final Pattern UNQUOTED_RESERVED_NAME_COLUMN_PATTERN = Pattern.compile("\\(\\s*NAME\\s*=\\s*name\\s*,\\s*CIPHER\\s*=", Pattern.CASE_INSENSITIVE);
+
+ private static final Pattern UNQUOTED_AES_TYPE_PATTERN = Pattern.compile("TYPE\\s*\\(\\s*NAME\\s*=\\s*AES\\b", Pattern.CASE_INSENSITIVE);
private final WorkflowValidationSupport validationSupport = new WorkflowValidationSupport();
@@ -69,12 +79,49 @@ public final class EncryptWorkflowValidationService implements MCPWorkflowRuntim
return validationSupport.finalizeValidation(workflowSessionContext, snapshot, validationReport);
}
+ @Override
+ public List<Map<String, Object>> validate(final WorkflowContextSnapshot snapshot, final Collection<ExecutableWorkflowArtifact> artifacts) {
+ List<Map<String, Object>> result = new LinkedList<>();
+ for (ExecutableWorkflowArtifact each : artifacts) {
+ if (each.ruleDistSql()) {
+ addRuleDistSQLIssues(result, each.sql(), each.displaySql());
+ }
+ }
+ return result;
+ }
+
@Override
public void synchronize(final WorkflowContextSnapshot snapshot, final MCPMetadataQueryFacade metadataQueryFacade,
final MCPFeatureQueryFacade queryFacade, final MCPFeatureExecutionFacade executionFacade, final String sessionId) {
workflowSynchronizationSupport.synchronize(() -> createValidationReport(snapshot, queryFacade));
}
+ private void addRuleDistSQLIssues(final List<Map<String, Object>> issues, final String sql, final String displaySql) {
+ if (!isEncryptRuleDistSQL(sql)) {
+ return;
+ }
+ if (UNQUOTED_RESERVED_NAME_COLUMN_PATTERN.matcher(sql).find()) {
+ issues.add(createValidationIssue("Generated encrypt DistSQL uses reserved logical column identifier `name` without DistSQL quoting.", displaySql));
+ }
+ if (UNQUOTED_AES_TYPE_PATTERN.matcher(sql).find()) {
+ issues.add(createValidationIssue("Generated encrypt DistSQL uses AES algorithm type without a string literal.", displaySql));
+ }
+ String actualSQL = sql.toLowerCase(Locale.ENGLISH);
+ if (actualSQL.contains("encrypt_algorithm") && actualSQL.contains("'aes-key-value'") && !actualSQL.contains("'digest-algorithm-name'")) {
+ issues.add(createValidationIssue("Generated AES encrypt DistSQL is missing `digest-algorithm-name`.", displaySql));
+ }
+ }
+
+ private boolean isEncryptRuleDistSQL(final String sql) {
+ String actualSQL = sql.trim().toUpperCase(Locale.ENGLISH);
+ return actualSQL.startsWith("CREATE ENCRYPT RULE") || actualSQL.startsWith("ALTER ENCRYPT RULE");
+ }
+
+ private Map<String, Object> createValidationIssue(final String message, final String sql) {
+ return new WorkflowIssue(WorkflowIssueCode.SQL_EXECUTABILITY_FAILED, "error", WorkflowLifecycle.STEP_REVIEW,
+ message, "Regenerate the workflow artifact through the feature planner before approval.", true, Map.of("sql", sql)).toMap();
+ }
+
private ValidationReport createValidationReport(final WorkflowContextSnapshot snapshot, final MCPFeatureQueryFacade queryFacade) {
ValidationReport result = new ValidationReport();
EncryptWorkflowRequest request = getWorkflowRequest(snapshot);
diff --git a/mcp/features/encrypt/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-encrypt.yaml b/mcp/features/encrypt/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-encrypt.yaml
index 2e91619294f..8ec24f6f9d2 100644
--- a/mcp/features/encrypt/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-encrypt.yaml
+++ b/mcp/features/encrypt/src/main/resources/META-INF/shardingsphere-mcp/mcp-descriptors/mcp-descriptor-encrypt.yaml
@@ -449,6 +449,11 @@ tools:
property_key: aes-key-value
required: true
secret: true
+ - role: primary
+ property_key: digest-algorithm-name
+ required: false
+ secret: false
+ default_value: SHA-1
validation_strategy: {}
delivery_mode: all-at-once
execution_mode: review-then-execute
@@ -471,10 +476,11 @@ tools:
artifact_type: rule_dist_sql
sql: >-
CREATE ENCRYPT RULE orders (COLUMNS((NAME=status, CIPHER=status_cipher,
- ENCRYPT_ALGORITHM(TYPE(NAME=AES, PROPERTIES('aes-key-value'='******'))))))
+ ENCRYPT_ALGORITHM(TYPE(NAME='aes', PROPERTIES('aes-key-value'='******', 'digest-algorithm-name'='SHA-1'))))))
masked_property_preview:
primary:
aes-key-value: "******"
+ digest-algorithm-name: SHA-1
assisted_query: {}
like_query: {}
resources_to_read:
diff --git a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/EncryptMCPHandlerProviderTest.java b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/EncryptMCPHandlerProviderTest.java
index 12ef9c24558..bb60d480f44 100644
--- a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/EncryptMCPHandlerProviderTest.java
+++ b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/EncryptMCPHandlerProviderTest.java
@@ -60,6 +60,7 @@ class EncryptMCPHandlerProviderTest {
WorkflowRuntimeDefinition actual = new EncryptMCPHandlerProvider().getWorkflowDefinitions().iterator().next();
assertThat(actual.getWorkflowKind(), is(EncryptFeatureDefinition.WORKFLOW_KIND));
assertThat(actual.getApplySynchronizationHandler(), isA(EncryptWorkflowValidationService.class));
+ assertThat(actual.getApplyArtifactValidator(), isA(EncryptWorkflowValidationService.class));
assertThat(actual.getValidationHandler(), isA(EncryptWorkflowValidationService.class));
}
}
diff --git a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidatorTest.java b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidatorTest.java
index bbe6d369562..d490aff58dd 100644
--- a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidatorTest.java
+++ b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/descriptor/EncryptToolDescriptorValidatorTest.java
@@ -183,6 +183,28 @@ class EncryptToolDescriptorValidatorTest {
assertTrue(String.valueOf(((Map<?, ?>) properties.get("like_query_algorithm_properties")).get("description")).contains("protected placeholder objects"));
}
+ @Test
+ void assertValidateExecutableEncryptDistSQLExamples() {
+ MCPToolDescriptor descriptor = MCPDescriptorCatalogIndex.getRequiredToolDescriptor(EncryptFeatureDefinition.PLAN_TOOL_NAME);
+ new EncryptToolDescriptorValidator().validate(descriptor);
+ }
+
+ @Test
+ void assertValidateRejectsUnquotedExecutableEncryptAlgorithmType() {
+ IllegalStateException actual = assertThrows(IllegalStateException.class, () -> new EncryptToolDescriptorValidator().validate(
+ createDescriptorWithExampleSQL("CREATE ENCRYPT RULE orders (COLUMNS((NAME=status, CIPHER=status_cipher, "
+ + "ENCRYPT_ALGORITHM(TYPE(NAME=AES, PROPERTIES('aes-key-value'='******', 'digest-algorithm-name'='SHA-1'))))))")));
+ assertThat(actual.getMessage(), is("Tool `database_gateway_plan_encrypt_rule` output example executable encrypt DistSQL must quote algorithm type as a string literal."));
+ }
+
+ @Test
+ void assertValidateRejectsMissingExecutableAesDigest() {
+ IllegalStateException actual = assertThrows(IllegalStateException.class, () -> new EncryptToolDescriptorValidator().validate(
+ createDescriptorWithExampleSQL("CREATE ENCRYPT RULE orders (COLUMNS((NAME=status, CIPHER=status_cipher, "
+ + "ENCRYPT_ALGORITHM(TYPE(NAME='aes', PROPERTIES('aes-key-value'='******'))))))")));
+ assertThat(actual.getMessage(), is("Tool `database_gateway_plan_encrypt_rule` output example executable AES DistSQL must include `digest-algorithm-name`."));
+ }
+
private MCPPromptDescriptor findPrompt(final String promptName) {
return MCPDescriptorCatalogIndex.getPromptDescriptors().stream().filter(each -> promptName.equals(each.getName())).findFirst().orElseThrow();
}
@@ -197,6 +219,14 @@ class EncryptToolDescriptorValidatorTest {
.anyMatch(each -> referenceType.equals(each.getReferenceType()) && reference.equals(each.getReference()));
}
+ private MCPToolDescriptor createDescriptorWithExampleSQL(final String sql) {
+ MCPToolDescriptor descriptor = MCPDescriptorCatalogIndex.getRequiredToolDescriptor(EncryptFeatureDefinition.PLAN_TOOL_NAME);
+ Map<String, Object> outputSchema = new LinkedHashMap<>(descriptor.getOutputSchema());
+ outputSchema.put("examples", List.of(Map.of("distsql_artifacts", List.of(Map.of("artifact_type", "rule_dist_sql", "sql", sql)))));
+ return new MCPToolDescriptor(descriptor.getName(), descriptor.getTitle(), descriptor.getDescription(), descriptor.getInputSchema(), outputSchema,
+ descriptor.getAnnotations(), descriptor.getMeta());
+ }
+
private String readResource(final String resourceName) throws IOException {
try (InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(resourceName)) {
return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
diff --git a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptRuleDistSQLPlanningServiceTest.java b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptRuleDistSQLPlanningServiceTest.java
index f6325265100..b0d62bab49e 100644
--- a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptRuleDistSQLPlanningServiceTest.java
+++ b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptRuleDistSQLPlanningServiceTest.java
@@ -39,12 +39,12 @@ class EncryptRuleDistSQLPlanningServiceTest {
EncryptWorkflowRequest request = createRequest("create", true, true);
List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("create"));
- assertTrue(actual.get(0).getSql().startsWith("CREATE ENCRYPT RULE orders"));
- assertTrue(actual.get(0).getSql().contains("NAME=phone"));
- assertTrue(actual.get(0).getSql().contains("CIPHER=phone_cipher"));
- assertTrue(actual.get(0).getSql().contains("ASSISTED_QUERY_COLUMN=phone_assisted_query"));
- assertTrue(actual.get(0).getSql().contains("LIKE_QUERY_COLUMN=phone_like_query"));
+ assertThat(actual.getFirst().getOperationType(), is("create"));
+ assertTrue(actual.getFirst().getSql().startsWith("CREATE ENCRYPT RULE orders"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=phone"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=phone_cipher"));
+ assertTrue(actual.getFirst().getSql().contains("ASSISTED_QUERY_COLUMN=phone_assisted_query"));
+ assertTrue(actual.getFirst().getSql().contains("LIKE_QUERY_COLUMN=phone_like_query"));
}
@Test
@@ -54,11 +54,11 @@ class EncryptRuleDistSQLPlanningServiceTest {
Map.of("logic_column", "phone", "cipher_column", "old_cipher", "encryptor_type", "AES", "encryptor_props", "aes-key-value=old"),
Map.of("logic_column", "email", "cipher_column", "email_cipher", "encryptor_type", "AES", "encryptor_props", "aes-key-value=old")), "MySQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("alter"));
- assertTrue(actual.get(0).getSql().startsWith("ALTER ENCRYPT RULE orders"));
- assertTrue(actual.get(0).getSql().contains("NAME=email"));
- assertTrue(actual.get(0).getSql().contains("NAME=phone"));
- assertTrue(actual.get(0).getSql().contains("CIPHER=phone_cipher"));
+ assertThat(actual.getFirst().getOperationType(), is("alter"));
+ assertTrue(actual.getFirst().getSql().startsWith("ALTER ENCRYPT RULE orders"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=email"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=phone"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=phone_cipher"));
}
@Test
@@ -67,7 +67,7 @@ class EncryptRuleDistSQLPlanningServiceTest {
request.setAlgorithmType("AES'X");
request.getPrimaryAlgorithmProperties().put("aes-key-value", "s'1");
List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
- assertTrue(actual.get(0).getSql().contains("TYPE(NAME='aes''x', PROPERTIES('aes-key-value'='s''1'))"));
+ assertTrue(actual.getFirst().getSql().contains("TYPE(NAME='aes''x', PROPERTIES('aes-key-value'='s''1'))"));
}
@Test
@@ -77,9 +77,9 @@ class EncryptRuleDistSQLPlanningServiceTest {
request.setColumn("Phone Number");
request.getOptions().setCipherColumnName("Phone Number Cipher");
List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
- assertTrue(actual.get(0).getSql().startsWith("CREATE ENCRYPT RULE `order detail`"));
- assertTrue(actual.get(0).getSql().contains("NAME=`Phone Number`"));
- assertTrue(actual.get(0).getSql().contains("CIPHER=`Phone Number Cipher`"));
+ assertTrue(actual.getFirst().getSql().startsWith("CREATE ENCRYPT RULE `order detail`"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=`Phone Number`"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=`Phone Number Cipher`"));
}
@Test
@@ -87,8 +87,33 @@ class EncryptRuleDistSQLPlanningServiceTest {
EncryptWorkflowRequest request = createRequest("create", false, false);
request.setTable("key");
List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
- assertTrue(actual.get(0).getSql().startsWith("CREATE ENCRYPT RULE `key`"));
- assertTrue(actual.get(0).getSql().contains("NAME=phone"));
+ assertTrue(actual.getFirst().getSql().startsWith("CREATE ENCRYPT RULE `key`"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=phone"));
+ }
+
+ @Test
+ void assertPlanEncryptRuleFormatsReservedColumnIdentifier() {
+ EncryptWorkflowRequest request = createRequest("create", false, false);
+ request.setTable("t_user");
+ request.setColumn("name");
+ request.getOptions().setCipherColumnName("name_cipher");
+ List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
+ assertTrue(actual.getFirst().getSql().startsWith("CREATE ENCRYPT RULE t_user"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=`name`"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=name_cipher"));
+ assertTrue(actual.getFirst().getSql().contains("TYPE(NAME='aes'"));
+ }
+
+ @Test
+ void assertPlanEncryptRuleFormatsReservedQueryColumnIdentifiers() {
+ EncryptWorkflowRequest request = createRequest("create", true, true);
+ request.getOptions().setCipherColumnName("cipher");
+ request.getOptions().setAssistedQueryColumnName("order");
+ request.getOptions().setLikeQueryColumnName("type");
+ List<RuleArtifact> actual = service.planEncryptRule(request, List.of(), "MySQL");
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=`cipher`"));
+ assertTrue(actual.getFirst().getSql().contains("ASSISTED_QUERY_COLUMN=`order`"));
+ assertTrue(actual.getFirst().getSql().contains("LIKE_QUERY_COLUMN=`type`"));
}
@Test
@@ -105,8 +130,8 @@ class EncryptRuleDistSQLPlanningServiceTest {
request.getOptions().setCipherColumnName("");
List<RuleArtifact> actual = service.planEncryptDropRule(request, List.of(Map.of("logic_column", "phone", "cipher_column", "phone_cipher")), "MySQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("drop"));
- assertThat(actual.get(0).getSql(), is("DROP ENCRYPT RULE orders"));
+ assertThat(actual.getFirst().getOperationType(), is("drop"));
+ assertThat(actual.getFirst().getSql(), is("DROP ENCRYPT RULE orders"));
}
@Test
@@ -117,10 +142,10 @@ class EncryptRuleDistSQLPlanningServiceTest {
Map.of("logic_column", "phone", "cipher_column", "phone_cipher"),
Map.of("logic_column", "email", "cipher_column", "email_cipher", "encryptor_type", "AES", "encryptor_props", "aes-key-value=old")), "MySQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("drop"));
- assertTrue(actual.get(0).getSql().startsWith("ALTER ENCRYPT RULE orders"));
- assertTrue(actual.get(0).getSql().contains("NAME=email"));
- assertTrue(actual.get(0).getSql().contains("CIPHER=email_cipher"));
+ assertThat(actual.getFirst().getOperationType(), is("drop"));
+ assertTrue(actual.getFirst().getSql().startsWith("ALTER ENCRYPT RULE orders"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=email"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=email_cipher"));
}
@Test
@@ -131,9 +156,9 @@ class EncryptRuleDistSQLPlanningServiceTest {
Map.of("logic_column", "Phone", "cipher_column", "Phone_cipher"),
Map.of("logic_column", "phone", "cipher_column", "phone_cipher", "encryptor_type", "AES", "encryptor_props", "aes-key-value=old")), "PostgreSQL");
assertThat(actual.size(), is(1));
- assertTrue(actual.get(0).getSql().startsWith("ALTER ENCRYPT RULE orders"));
- assertTrue(actual.get(0).getSql().contains("NAME=phone"));
- assertTrue(actual.get(0).getSql().contains("CIPHER=phone_cipher"));
+ assertTrue(actual.getFirst().getSql().startsWith("ALTER ENCRYPT RULE orders"));
+ assertTrue(actual.getFirst().getSql().contains("NAME=phone"));
+ assertTrue(actual.getFirst().getSql().contains("CIPHER=phone_cipher"));
}
@Test
@@ -142,8 +167,8 @@ class EncryptRuleDistSQLPlanningServiceTest {
request.setColumn("Phone");
List<RuleArtifact> actual = service.planEncryptDropRule(request, List.of(Map.of("logic_column", "phone", "cipher_column", "phone_cipher")), "PostgreSQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("drop"));
- assertThat(actual.get(0).getSql(), is("DROP ENCRYPT RULE orders"));
+ assertThat(actual.getFirst().getOperationType(), is("drop"));
+ assertThat(actual.getFirst().getSql(), is("DROP ENCRYPT RULE orders"));
}
@Test
@@ -152,8 +177,8 @@ class EncryptRuleDistSQLPlanningServiceTest {
request.setColumn("Phone");
List<RuleArtifact> actual = service.planEncryptDropRule(request, List.of(Map.of("logic_column", "phone", "cipher_column", "phone_cipher")), "MySQL");
assertThat(actual.size(), is(1));
- assertThat(actual.get(0).getOperationType(), is("drop"));
- assertThat(actual.get(0).getSql(), is("DROP ENCRYPT RULE orders"));
+ assertThat(actual.getFirst().getOperationType(), is("drop"));
+ assertThat(actual.getFirst().getSql(), is("DROP ENCRYPT RULE orders"));
}
private EncryptWorkflowRequest createRequest(final String operationType, final boolean equalityFilter, final boolean likeQuery) {
diff --git a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowPlanningServiceTest.java b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowPlanningServiceTest.java
index 2108691ef2a..5dbb2d995fb 100644
--- a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowPlanningServiceTest.java
+++ b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowPlanningServiceTest.java
@@ -204,6 +204,25 @@ class EncryptWorkflowPlanningServiceTest {
assertTrue(actual.getIndexPlans().isEmpty());
}
+ @Test
+ void assertPlanEncryptRuleWithReservedColumnAndDefaultDigest() throws ReflectiveOperationException {
+ EncryptRuleInspectionService ruleInspectionService = mock(EncryptRuleInspectionService.class);
+ when(ruleInspectionService.queryEncryptRules(any(), any(), any())).thenReturn(List.of());
+ EncryptWorkflowRequest request = createRequest("create");
+ request.setTable("t_user");
+ request.setColumn("name");
+ request.getOptions().setCipherColumnName("name_cipher");
+ WorkflowContextSnapshot actual = createService(ruleInspectionService, createPrimaryCandidateRecommendation(), new EncryptAlgorithmPropertyTemplateService(),
+ new EncryptRuleDistSQLPlanningService()).plan(new TestWorkflowSessionContext(), createMetadataQueryFacade(), mock(MCPFeatureQueryFacade.class), "session-1", request);
+ String actualSQL = actual.getRuleArtifacts().getFirst().getSql();
+ assertThat(actual.getStatus(), is("planned"));
+ assertTrue(actualSQL.startsWith("CREATE ENCRYPT RULE t_user"));
+ assertTrue(actualSQL.contains("NAME=`name`"));
+ assertTrue(actualSQL.contains("CIPHER=name_cipher"));
+ assertTrue(actualSQL.contains("TYPE(NAME='aes'"));
+ assertTrue(actualSQL.contains("'digest-algorithm-name'='SHA-1'"));
+ }
+
@Test
void assertPlanRejectsAddingColumnToExistingTableRule() throws ReflectiveOperationException {
EncryptRuleInspectionService ruleInspectionService = mock(EncryptRuleInspectionService.class);
diff --git a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationServiceTest.java b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationServiceTest.java
index 576a9b182cb..c576cbbb010 100644
--- a/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationServiceTest.java
+++ b/mcp/features/encrypt/src/test/java/org/apache/shardingsphere/mcp/feature/encrypt/tool/service/EncryptWorkflowValidationServiceTest.java
@@ -31,6 +31,8 @@ import org.apache.shardingsphere.mcp.support.workflow.model.RuleWorkflowFeatureD
import org.apache.shardingsphere.mcp.support.workflow.model.SecretReferenceValue;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowIssueCode;
+import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowArtifactBundle.ExecutableWorkflowArtifact;
+import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowArtifactPayloadUtils;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSynchronizationException;
import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowSynchronizationSupport;
import org.junit.jupiter.api.Test;
@@ -44,6 +46,7 @@ import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verifyNoInteractions;
@@ -86,6 +89,35 @@ class EncryptWorkflowValidationServiceTest {
verifyNoInteractions(executionFacade);
}
+ @Test
+ void assertValidateApplyArtifactsRejectsInvalidGeneratedEncryptRuleArtifact() {
+ String sql = "CREATE ENCRYPT RULE t_user (COLUMNS((NAME=name, CIPHER=name_cipher, "
+ + "ENCRYPT_ALGORITHM(TYPE(NAME=AES, PROPERTIES('aes-key-value'='123456'))))))";
+ List<Map<String, Object>> actual = new EncryptWorkflowValidationService().validate(new WorkflowContextSnapshot(),
+ List.of(createRuleDistSQLArtifact(sql, sql.replace("123456", "******"))));
+ assertThat(actual.size(), is(3));
+ assertThat(actual.getFirst().get("code"), is(WorkflowIssueCode.SQL_EXECUTABILITY_FAILED));
+ assertThat(actual.getFirst().get("message"), is("Generated encrypt DistSQL uses reserved logical column identifier `name` without DistSQL quoting."));
+ assertFalse(String.valueOf(actual).contains("123456"));
+ }
+
+ @Test
+ void assertValidateApplyArtifactsAllowsNamePrefixColumn() {
+ String sql = "CREATE ENCRYPT RULE t_user (COLUMNS((NAME=name_cipher, CIPHER=name_cipher_value, "
+ + "ENCRYPT_ALGORITHM(TYPE(NAME='aes', PROPERTIES('aes-key-value'='123456', 'digest-algorithm-name'='SHA-1'))))))";
+ List<Map<String, Object>> actual = new EncryptWorkflowValidationService().validate(new WorkflowContextSnapshot(),
+ List.of(createRuleDistSQLArtifact(sql, sql.replace("123456", "******"))));
+ assertTrue(actual.isEmpty());
+ }
+
+ @Test
+ void assertValidateApplyArtifactsIgnoresNonEncryptRuleArtifacts() {
+ String sql = "CREATE MASK RULE orders (COLUMNS((NAME=name, "
+ + "MASK_ALGORITHM(TYPE(NAME=AES, PROPERTIES('description'='CREATE ENCRYPT RULE', 'aes-key-value'='123456'))))))";
+ List<Map<String, Object>> actual = new EncryptWorkflowValidationService().validate(new WorkflowContextSnapshot(), List.of(createRuleDistSQLArtifact(sql, sql)));
+ assertTrue(actual.isEmpty());
+ }
+
@Test
void assertSynchronize() throws ReflectiveOperationException {
WorkflowContextSnapshot snapshot = createSnapshot("plan-1", "session-1", "executed", "create");
@@ -309,4 +341,8 @@ class EncryptWorkflowValidationServiceTest {
"cipher_column", "phone_cipher",
"encryptor_type", "AES");
}
+
+ private ExecutableWorkflowArtifact createRuleDistSQLArtifact(final String sql, final String displaySql) {
+ return new ExecutableWorkflowArtifact(WorkflowArtifactPayloadUtils.STEP_RULE_DISTSQL, WorkflowArtifactPayloadUtils.ARTIFACT_TYPE_RULE_DISTSQL, sql, displaySql, true);
+ }
}
diff --git a/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskAlgorithmPropertyTemplateServiceTest.java b/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskAlgorithmPropertyTemplateServiceTest.java
index 151c7cd617e..c908269a4f9 100644
--- a/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskAlgorithmPropertyTemplateServiceTest.java
+++ b/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskAlgorithmPropertyTemplateServiceTest.java
@@ -36,7 +36,14 @@ class MaskAlgorithmPropertyTemplateServiceTest {
List<AlgorithmPropertyRequirement> actual = service.findRequirements("MASK_FROM_X_TO_Y");
assertThat(actual.size(), is(3));
assertThat(actual.get(0).getPropertyKey(), is("from-x"));
+ assertThat(actual.get(0).getDefaultValue(), is(""));
+ assertTrue(actual.get(0).isRequired());
+ assertThat(actual.get(1).getPropertyKey(), is("to-y"));
+ assertThat(actual.get(1).getDefaultValue(), is(""));
+ assertTrue(actual.get(1).isRequired());
+ assertThat(actual.get(2).getPropertyKey(), is("replace-char"));
assertThat(actual.get(2).getDefaultValue(), is("*"));
+ assertTrue(actual.get(2).isRequired());
}
@Test
diff --git a/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskRuleDistSQLPlanningServiceTest.java b/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskRuleDistSQLPlanningServiceTest.java
index 3ae8354dbe2..5fad250df3f 100644
--- a/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskRuleDistSQLPlanningServiceTest.java
+++ b/mcp/features/mask/src/test/java/org/apache/shardingsphere/mcp/feature/mask/tool/service/MaskRuleDistSQLPlanningServiceTest.java
@@ -68,6 +68,16 @@ class MaskRuleDistSQLPlanningServiceTest {
assertTrue(actual.getSql().contains("NAME=phone"));
}
+ @Test
+ void assertPlanMaskRuleFormatsReservedColumnIdentifier() {
+ WorkflowRequest request = createRequest("create");
+ request.setTable("table");
+ request.setColumn("from");
+ RuleArtifact actual = service.planMaskRule(request);
+ assertTrue(actual.getSql().startsWith("CREATE MASK RULE `table`"));
+ assertTrue(actual.getSql().contains("NAME=`from`"));
+ }
+
@Test
void assertPlanMaskRuleRejectsLineTerminatorColumn() {
MCPInvalidRequestException actualException = assertThrows(MCPInvalidRequestException.class,
diff --git a/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingAlgorithmPropertyTemplateServiceTest.java b/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingAlgorithmPropertyTemplateServiceTest.java
index 02279bcfdb1..77d072d7aaf 100644
--- a/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingAlgorithmPropertyTemplateServiceTest.java
+++ b/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingAlgorithmPropertyTemplateServiceTest.java
@@ -40,6 +40,16 @@ class ReadwriteSplittingAlgorithmPropertyTemplateServiceTest {
assertThat(actual.get(1).getPropertyKey(), is("read_ds_1"));
}
+ @Test
+ void assertFindRequirementsForWeightWithReservedStorageUnits() {
+ List<AlgorithmPropertyRequirement> actual = service.findRequirements("WEIGHT", List.of("order", "table", ""));
+ assertThat(actual.size(), is(2));
+ assertThat(actual.getFirst().getPropertyKey(), is("order"));
+ assertTrue(actual.getFirst().isRequired());
+ assertThat(actual.get(1).getPropertyKey(), is("table"));
+ assertTrue(actual.get(1).isRequired());
+ }
+
@Test
void assertFindRequirementsForRandom() {
assertTrue(service.findRequirements("RANDOM", List.of("read_ds_0")).isEmpty());
diff --git a/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingDistSQLPlanningServiceTest.java b/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingDistSQLPlanningServiceTest.java
index bfa0a20d409..068555b32e0 100644
--- a/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingDistSQLPlanningServiceTest.java
+++ b/mcp/features/readwrite-splitting/src/test/java/org/apache/shardingsphere/mcp/feature/readwritesplitting/tool/service/ReadwriteSplittingDistSQLPlanningServiceTest.java
@@ -38,6 +38,19 @@ class ReadwriteSplittingDistSQLPlanningServiceTest {
+ "TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC', TYPE(NAME='weight', PROPERTIES('read_ds_0'='2')))"));
}
+ @Test
+ void assertPlanCreateRuleFormatsReservedIdentifiers() {
+ ReadwriteSplittingRuleWorkflowRequest request = createRuleRequest();
+ request.setRuleName("type");
+ request.setWriteStorageUnit("from");
+ request.setReadStorageUnits("order,table");
+ request.getLoadBalancerProperties().clear();
+ request.putLoadBalancerProperties(Map.of("order", "2", "table", "1"));
+ assertThat(new ReadwriteSplittingRuleDistSQLPlanningService().planCreateRule(request).getSql(),
+ is("CREATE READWRITE_SPLITTING RULE `type` (WRITE_STORAGE_UNIT=`from`, READ_STORAGE_UNITS(`order`, `table`), "
+ + "TRANSACTIONAL_READ_QUERY_STRATEGY='DYNAMIC', TYPE(NAME='weight', PROPERTIES('order'='2', 'table'='1')))"));
+ }
+
@Test
void assertPlanAlterRule() {
assertThat(new ReadwriteSplittingRuleDistSQLPlanningService().planAlterRule(createRuleRequest()).getOperationType(), is("alter"));
diff --git a/mcp/features/shadow/src/test/java/org/apache/shardingsphere/mcp/feature/shadow/tool/service/ShadowDistSQLPlanningServiceTest.java b/mcp/features/shadow/src/test/java/org/apache/shardingsphere/mcp/feature/shadow/tool/service/ShadowDistSQLPlanningServiceTest.java
index 9165762f821..f3b2d0875bb 100644
--- a/mcp/features/shadow/src/test/java/org/apache/shardingsphere/mcp/feature/shadow/tool/service/ShadowDistSQLPlanningServiceTest.java
+++ b/mcp/features/shadow/src/test/java/org/apache/shardingsphere/mcp/feature/shadow/tool/service/ShadowDistSQLPlanningServiceTest.java
@@ -39,6 +39,18 @@ class ShadowDistSQLPlanningServiceTest {
assertNoForbiddenArtifacts(actual.getSql());
}
+ @Test
+ void assertPlanCreateRuleFormatsReservedIdentifiers() {
+ ShadowRuleWorkflowRequest request = createRuleRequest();
+ request.setRuleName("type");
+ request.setSourceStorageUnit("from");
+ request.setShadowStorageUnit("table");
+ request.setTableName("order");
+ RuleArtifact actual = new ShadowDistSQLPlanningService().planCreateRule(request);
+ assertThat(actual.getSql(), is("CREATE SHADOW RULE `type`(SOURCE=`from`, SHADOW=`table`, "
+ + "`order`(TYPE(NAME='value_match', PROPERTIES('column'='user_id', 'operation'='insert', 'value'='1'))))"));
+ }
+
@Test
void assertPlanAlterRule() {
assertTrue(new ShadowDistSQLPlanningService().planAlterRule(createRuleRequest()).getSql().startsWith("ALTER SHADOW RULE shadow_rule"));
diff --git a/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingAlgorithmPropertyTemplateServiceTest.java b/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingAlgorithmPropertyTemplateServiceTest.java
index 33c89ad760a..66ca65f65fd 100644
--- a/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingAlgorithmPropertyTemplateServiceTest.java
+++ b/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingAlgorithmPropertyTemplateServiceTest.java
@@ -43,6 +43,19 @@ class ShardingAlgorithmPropertyTemplateServiceTest {
assertThat(service.findAlgorithmRequirements("MOD").getFirst().getPropertyKey(), is("sharding-count"));
}
+ @Test
+ void assertFindAlgorithmRequirementsForHashMod() {
+ List<AlgorithmPropertyRequirement> actual = service.findAlgorithmRequirements("HASH_MOD");
+ assertThat(actual.getFirst().getPropertyKey(), is("sharding-count"));
+ assertTrue(actual.getFirst().isRequired());
+ }
+
+ @Test
+ void assertFindAlgorithmRequirementsForInlineVariants() {
+ assertThat(service.findAlgorithmRequirements("COMPLEX_INLINE").getFirst().getPropertyKey(), is("algorithm-expression"));
+ assertThat(service.findAlgorithmRequirements("HINT_INLINE").getFirst().getPropertyKey(), is("algorithm-expression"));
+ }
+
@Test
void assertFindKeyGeneratorRequirementsForSnowflake() {
List<AlgorithmPropertyRequirement> actual = service.findKeyGeneratorRequirements("SNOWFLAKE");
diff --git a/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingDistSQLPlanningServiceTest.java b/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingDistSQLPlanningServiceTest.java
index c466447de3e..539ad853f1c 100644
--- a/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingDistSQLPlanningServiceTest.java
+++ b/mcp/features/sharding/src/test/java/org/apache/shardingsphere/mcp/feature/sharding/tool/service/ShardingDistSQLPlanningServiceTest.java
@@ -40,6 +40,19 @@ class ShardingDistSQLPlanningServiceTest {
assertNoForbiddenArtifacts(actual.getSql());
}
+ @Test
+ void assertPlanTableRuleCreateFormatsReservedIdentifiers() {
+ ShardingWorkflowRequest request = createTableRuleRequest();
+ request.setTable("table");
+ request.setColumn("from");
+ request.setKeyGenerateColumn("key");
+ RuleArtifact actual = new ShardingDistSQLPlanningService().planTableRule(request, "create");
+ assertThat(actual.getSql(), is("CREATE SHARDING TABLE RULE `table`(DATANODES('ds_${0..1}.t_order_${0..1}'), "
+ + "TABLE_STRATEGY(TYPE='standard', SHARDING_COLUMN=`from`, "
+ + "SHARDING_ALGORITHM(TYPE(NAME='inline', PROPERTIES('algorithm-expression'='t_order_${order_id % 2}')))), "
+ + "KEY_GENERATE_STRATEGY(COLUMN=`key`, TYPE(NAME='snowflake')))"));
+ }
+
@Test
void assertPlanTableRuleCreateWithComplexStrategy() {
ShardingWorkflowRequest request = createTableRuleRequest();
diff --git a/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java b/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/MCPWorkflowApplyArtifactValidator.java
similarity index 55%
copy from mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java
copy to mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/MCPWorkflowApplyArtifactValidator.java
index d5a3909a834..de87a1779ae 100644
--- a/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java
+++ b/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/MCPWorkflowApplyArtifactValidator.java
@@ -17,30 +17,27 @@
package org.apache.shardingsphere.mcp.support.workflow.spi;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
+import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowContextSnapshot;
+import org.apache.shardingsphere.mcp.support.workflow.service.WorkflowArtifactBundle.ExecutableWorkflowArtifact;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
/**
- * Workflow runtime definition.
+ * Workflow apply artifact validator.
*/
-@RequiredArgsConstructor
-@Getter
-public final class WorkflowRuntimeDefinition {
-
- private final WorkflowKind workflowKind;
-
- private final MCPWorkflowValidationHandler validationHandler;
+@FunctionalInterface
+public interface MCPWorkflowApplyArtifactValidator {
- private final MCPWorkflowApplySynchronizationHandler applySynchronizationHandler;
+ MCPWorkflowApplyArtifactValidator NO_OP = (snapshot, artifacts) -> List.of();
/**
- * Create workflow runtime definition with one handler for validation and apply synchronization.
+ * Validate executable workflow artifacts before preview or apply.
*
- * @param workflowKind workflow kind
- * @param runtimeHandler workflow runtime handler
+ * @param snapshot workflow snapshot
+ * @param artifacts executable workflow artifacts
+ * @return validation issues
*/
- public WorkflowRuntimeDefinition(final WorkflowKind workflowKind, final MCPWorkflowRuntimeHandler runtimeHandler) {
- this(workflowKind, runtimeHandler, runtimeHandler);
- }
+ List<Map<String, Object>> validate(WorkflowContextSnapshot snapshot, Collection<ExecutableWorkflowArtifact> artifacts);
}
diff --git a/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java b/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java
index d5a3909a834..b8a7a128c82 100644
--- a/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java
+++ b/mcp/support/src/main/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinition.java
@@ -18,13 +18,11 @@
package org.apache.shardingsphere.mcp.support.workflow.spi;
import lombok.Getter;
-import lombok.RequiredArgsConstructor;
import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
/**
* Workflow runtime definition.
*/
-@RequiredArgsConstructor
@Getter
public final class WorkflowRuntimeDefinition {
@@ -34,6 +32,36 @@ public final class WorkflowRuntimeDefinition {
private final MCPWorkflowApplySynchronizationHandler applySynchronizationHandler;
+ private final MCPWorkflowApplyArtifactValidator applyArtifactValidator;
+
+ /**
+ * Create workflow runtime definition.
+ *
+ * @param workflowKind workflow kind
+ * @param validationHandler workflow validation handler
+ * @param applySynchronizationHandler workflow apply synchronization handler
+ */
+ public WorkflowRuntimeDefinition(final WorkflowKind workflowKind, final MCPWorkflowValidationHandler validationHandler,
+ final MCPWorkflowApplySynchronizationHandler applySynchronizationHandler) {
+ this(workflowKind, validationHandler, applySynchronizationHandler, MCPWorkflowApplyArtifactValidator.NO_OP);
+ }
+
+ /**
+ * Create workflow runtime definition.
+ *
+ * @param workflowKind workflow kind
+ * @param validationHandler workflow validation handler
+ * @param applySynchronizationHandler workflow apply synchronization handler
+ * @param applyArtifactValidator workflow apply artifact validator
+ */
+ public WorkflowRuntimeDefinition(final WorkflowKind workflowKind, final MCPWorkflowValidationHandler validationHandler,
+ final MCPWorkflowApplySynchronizationHandler applySynchronizationHandler, final MCPWorkflowApplyArtifactValidator applyArtifactValidator) {
+ this.workflowKind = workflowKind;
+ this.validationHandler = validationHandler;
+ this.applySynchronizationHandler = applySynchronizationHandler;
+ this.applyArtifactValidator = applyArtifactValidator;
+ }
+
/**
* Create workflow runtime definition with one handler for validation and apply synchronization.
*
@@ -41,6 +69,10 @@ public final class WorkflowRuntimeDefinition {
* @param runtimeHandler workflow runtime handler
*/
public WorkflowRuntimeDefinition(final WorkflowKind workflowKind, final MCPWorkflowRuntimeHandler runtimeHandler) {
- this(workflowKind, runtimeHandler, runtimeHandler);
+ this(workflowKind, runtimeHandler, runtimeHandler, createApplyArtifactValidator(runtimeHandler));
+ }
+
+ private static MCPWorkflowApplyArtifactValidator createApplyArtifactValidator(final MCPWorkflowRuntimeHandler runtimeHandler) {
+ return runtimeHandler instanceof MCPWorkflowApplyArtifactValidator ? (MCPWorkflowApplyArtifactValidator) runtimeHandler : MCPWorkflowApplyArtifactValidator.NO_OP;
}
}
diff --git a/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/service/WorkflowSQLUtilsTest.java b/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/service/WorkflowSQLUtilsTest.java
index 14a4ffcfb35..2151322709e 100644
--- a/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/service/WorkflowSQLUtilsTest.java
+++ b/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/service/WorkflowSQLUtilsTest.java
@@ -269,6 +269,12 @@ class WorkflowSQLUtilsTest {
Arguments.of("quote exists keyword", "exists", "`exists`"),
Arguments.of("quote true keyword", "true", "`true`"),
Arguments.of("quote false keyword", "false", "`false`"),
+ Arguments.of("quote name keyword", "name", "`name`"),
+ Arguments.of("quote cipher keyword", "cipher", "`cipher`"),
+ Arguments.of("quote order keyword", "order", "`order`"),
+ Arguments.of("quote type keyword", "type", "`type`"),
+ Arguments.of("quote table keyword", "table", "`table`"),
+ Arguments.of("quote from keyword", "from", "`from`"),
Arguments.of("quote properties keyword", "properties", "`properties`"),
Arguments.of("quote encrypt algorithm keyword", "encrypt_algorithm", "`encrypt_algorithm`"),
Arguments.of("quote assisted query column keyword", "assisted_query_column", "`assisted_query_column`"),
diff --git a/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinitionTest.java b/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinitionTest.java
new file mode 100644
index 00000000000..d3e27360ec3
--- /dev/null
+++ b/mcp/support/src/test/java/org/apache/shardingsphere/mcp/support/workflow/spi/WorkflowRuntimeDefinitionTest.java
@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+package org.apache.shardingsphere.mcp.support.workflow.spi;
+
+import org.apache.shardingsphere.mcp.support.workflow.model.WorkflowKind;
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.withSettings;
+
+class WorkflowRuntimeDefinitionTest {
+
+ @Test
+ void assertCreateWithRuntimeHandlerUsesApplyArtifactValidator() {
+ MCPWorkflowRuntimeHandler runtimeHandler = mock(MCPWorkflowRuntimeHandler.class, withSettings().extraInterfaces(MCPWorkflowApplyArtifactValidator.class));
+ WorkflowRuntimeDefinition actual = new WorkflowRuntimeDefinition(WorkflowKind.valueOf("encrypt.rule"), runtimeHandler);
+ assertThat(actual.getApplyArtifactValidator(), is((MCPWorkflowApplyArtifactValidator) runtimeHandler));
+ }
+
+ @Test
+ void assertCreateWithRuntimeHandlerUsesNoOpApplyArtifactValidator() {
+ WorkflowRuntimeDefinition actual = new WorkflowRuntimeDefinition(WorkflowKind.valueOf("encrypt.rule"), mock(MCPWorkflowRuntimeHandler.class));
+ assertThat(actual.getApplyArtifactValidator(), is(MCPWorkflowApplyArtifactValidator.NO_OP));
+ }
+}
diff --git a/test/e2e/mcp/src/test/resources/baseline-contract/model-contract/capabilities.yaml b/test/e2e/mcp/src/test/resources/baseline-contract/model-contract/capabilities.yaml
index eed9ab21a4e..2e97765c972 100644
--- a/test/e2e/mcp/src/test/resources/baseline-contract/model-contract/capabilities.yaml
+++ b/test/e2e/mcp/src/test/resources/baseline-contract/model-contract/capabilities.yaml
@@ -171,9 +171,9 @@ common_flows:
referenced_resources: ['shardingsphere://capabilities']
protocolAvailability: {resources: true, resourceTemplates: true, tools: true, toolAnnotations: true,
toolOutputSchemas: true, prompts: true, completions: true, resourceNavigation: true}
-fingerprints: {algorithm: sha256, descriptorCatalog: 00daf55d3c305536e4d35e991cc2a4bbc98d96dc5138779e29299ddc071d2ba2,
+fingerprints: {algorithm: sha256, descriptorCatalog: 28f6490a0c3745ae0c992aa89268fe6352d8a8c97c7276ac7123233c4456b1c1,
promptSet: 3232cdab7c69f8e627da044e3d85f2dd72a0d08102541a42f6b9d75c89b2557e, resourceNavigation: 241f02eb306c284cbb2535ee38390f8d962e0288d7ee34c8cf0ed363a44ab741,
- modelFacingSchemas: a20c2fcafac6c844721fc6065a5a4f14d3214bafd5b7313d0bfe60a8192636a5}
+ modelFacingSchemas: 16a15a5912d4258496ce3faf866fad4f95e9c3f23682b23f8e1be2964d0a72ec}
resources:
- uri: shardingsphere://capabilities
name: server-capability-catalog