feat: add release diff rollback plan
This commit is contained in:
@@ -11,9 +11,11 @@ import java.security.NoSuchAlgorithmException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HexFormat;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import com.fasterxml.jackson.databind.JsonNode;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
@@ -94,13 +96,50 @@ public final class Eip4Cli {
|
||||
return 0;
|
||||
}
|
||||
return switch (args[1]) {
|
||||
case "diff" -> runReleaseDiff(args, out, err);
|
||||
case "export" -> runReleaseExport(args, out);
|
||||
case "import-preview" -> runReleaseImportPreview(args, out, err);
|
||||
case "rollback-plan" -> runReleaseRollbackPlan(args, out, err);
|
||||
case "verify" -> runReleaseVerify(args, out, err);
|
||||
default -> fail(err, "Unknown release command: " + args[1]);
|
||||
};
|
||||
}
|
||||
|
||||
private int runReleaseDiff(String[] args, PrintStream out, PrintStream err) throws IOException {
|
||||
Options options = Options.parse(args, 2);
|
||||
Path leftFile = Path.of(requiredPart(options.single("left"), "left"));
|
||||
Path rightFile = Path.of(requiredPart(options.single("right"), "right"));
|
||||
JsonNode leftRoot = objectMapper.readTree(Files.readString(leftFile, StandardCharsets.UTF_8));
|
||||
JsonNode rightRoot = objectMapper.readTree(Files.readString(rightFile, StandardCharsets.UTF_8));
|
||||
List<String> blockers = new ArrayList<>();
|
||||
validateEnvelope(leftRoot, blockers, false);
|
||||
validateEnvelope(rightRoot, blockers, false);
|
||||
JsonNode leftPayload = packagePayload(leftRoot);
|
||||
JsonNode rightPayload = packagePayload(rightRoot);
|
||||
JsonNode leftDeploymentPackage = deploymentPackage(leftPayload);
|
||||
JsonNode rightDeploymentPackage = deploymentPackage(rightPayload);
|
||||
ObjectNode report = buildReleaseDiff(leftPayload, rightPayload, leftDeploymentPackage, rightDeploymentPackage);
|
||||
report.put("status", blockers.isEmpty() ? "PASSED" : "FAILED");
|
||||
ArrayNode blockerNodes = report.putArray("blockers");
|
||||
blockers.forEach(blockerNodes::add);
|
||||
if (!blockers.isEmpty()) {
|
||||
return printReleaseOperationFailed("Release diff", blockers, err);
|
||||
}
|
||||
if (options.has("json-output")) {
|
||||
out.println(objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(report));
|
||||
return 0;
|
||||
}
|
||||
out.println("Release diff " + (report.path("changed").asBoolean(false) ? "CHANGED" : "UNCHANGED"));
|
||||
out.println("leftPackageId: " + report.path("leftPackageId").asText());
|
||||
out.println("rightPackageId: " + report.path("rightPackageId").asText());
|
||||
printArrayDiffSummary(report.path("sqlStatements"), out, "sqlStatements");
|
||||
printArrayDiffSummary(report.path("rollbackSqlStatements"), out, "rollbackSqlStatements");
|
||||
if (report.path("manifestChanged").asBoolean(false)) {
|
||||
out.println("manifest: changed");
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
private int runReleaseExport(String[] args, PrintStream out) throws IOException {
|
||||
Options options = Options.parse(args, 2);
|
||||
Path packageFile = Path.of(requiredPart(options.single("package-file"), "package-file"));
|
||||
@@ -134,6 +173,33 @@ public final class Eip4Cli {
|
||||
return printReleaseValidation(validation, options, out, err, "Import preview");
|
||||
}
|
||||
|
||||
private int runReleaseRollbackPlan(String[] args, PrintStream out, PrintStream err) throws IOException {
|
||||
Options options = Options.parse(args, 2);
|
||||
Path packageFile = Path.of(requiredPart(options.single("package-file"), "package-file"));
|
||||
Path output = Path.of(requiredPart(options.single("output"), "output"));
|
||||
JsonNode raw = objectMapper.readTree(Files.readString(packageFile, StandardCharsets.UTF_8));
|
||||
List<String> blockers = new ArrayList<>();
|
||||
validateEnvelope(raw, blockers, false);
|
||||
JsonNode payload = packagePayload(raw);
|
||||
JsonNode deploymentPackage = deploymentPackage(payload);
|
||||
validateRollbackPlanSource(payload, deploymentPackage, blockers);
|
||||
if (!blockers.isEmpty()) {
|
||||
return printReleaseOperationFailed("Rollback plan", blockers, err);
|
||||
}
|
||||
ObjectNode plan = buildRollbackPlan(raw, payload, deploymentPackage);
|
||||
if (output.getParent() != null) {
|
||||
Files.createDirectories(output.getParent());
|
||||
}
|
||||
Files.writeString(output,
|
||||
objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(plan) + System.lineSeparator(),
|
||||
StandardCharsets.UTF_8);
|
||||
out.println("Wrote rollback plan: " + output.toAbsolutePath());
|
||||
out.println("packageId: " + plan.path("packageId").asText());
|
||||
out.println("rollbackSqlStatements: " + plan.path("rollbackSqlStatements").size());
|
||||
out.println("mode: " + plan.path("mode").asText());
|
||||
return 0;
|
||||
}
|
||||
|
||||
private int runReleaseVerify(String[] args, PrintStream out, PrintStream err) throws IOException {
|
||||
Options options = Options.parse(args, 2);
|
||||
Path packageFile = Path.of(requiredPart(options.single("package-file"), "package-file"));
|
||||
@@ -169,6 +235,80 @@ public final class Eip4Cli {
|
||||
return new ReleaseValidation(report, List.copyOf(blockers), List.copyOf(warnings));
|
||||
}
|
||||
|
||||
private ObjectNode buildReleaseDiff(JsonNode leftPayload, JsonNode rightPayload,
|
||||
JsonNode leftDeploymentPackage, JsonNode rightDeploymentPackage) {
|
||||
ObjectNode report = objectMapper.createObjectNode();
|
||||
String leftPackageId = packageId(leftPayload, leftDeploymentPackage);
|
||||
String rightPackageId = packageId(rightPayload, rightDeploymentPackage);
|
||||
report.put("leftPackageId", leftPackageId);
|
||||
report.put("rightPackageId", rightPackageId);
|
||||
ObjectNode fields = report.putObject("fields");
|
||||
putScalarDiff(fields, "packageId", leftPackageId, rightPackageId);
|
||||
putScalarDiff(fields, "taskId", text(leftDeploymentPackage, "taskId"), text(rightDeploymentPackage, "taskId"));
|
||||
putScalarDiff(fields, "changeSetId", text(leftDeploymentPackage, "changeSetId"),
|
||||
text(rightDeploymentPackage, "changeSetId"));
|
||||
ObjectNode sqlDiff = textArrayDiff(leftDeploymentPackage.path("sqlStatements"),
|
||||
rightDeploymentPackage.path("sqlStatements"));
|
||||
ObjectNode rollbackDiff = textArrayDiff(leftDeploymentPackage.path("rollbackSqlStatements"),
|
||||
rightDeploymentPackage.path("rollbackSqlStatements"));
|
||||
report.set("sqlStatements", sqlDiff);
|
||||
report.set("rollbackSqlStatements", rollbackDiff);
|
||||
boolean manifestChanged = !leftDeploymentPackage.path("manifest").equals(rightDeploymentPackage.path("manifest"));
|
||||
report.put("manifestChanged", manifestChanged);
|
||||
boolean fieldsChanged = fieldsChanged(fields);
|
||||
report.put("changed", fieldsChanged
|
||||
|| sqlDiff.path("changed").asBoolean(false)
|
||||
|| rollbackDiff.path("changed").asBoolean(false)
|
||||
|| manifestChanged);
|
||||
return report;
|
||||
}
|
||||
|
||||
private ObjectNode buildRollbackPlan(JsonNode root, JsonNode payload, JsonNode deploymentPackage) {
|
||||
ObjectNode plan = objectMapper.createObjectNode();
|
||||
plan.put("type", "EIP4_ROLLBACK_PLAN");
|
||||
plan.put("version", 1);
|
||||
plan.put("generatedAt", System.currentTimeMillis());
|
||||
plan.put("packageId", packageId(payload, deploymentPackage));
|
||||
plan.put("taskId", text(deploymentPackage, "taskId"));
|
||||
plan.put("changeSetId", text(deploymentPackage, "changeSetId"));
|
||||
plan.put("sourceChecksum", root.path("checksum").asText(""));
|
||||
plan.put("requiresHumanApproval", true);
|
||||
plan.put("mode", "PLAN_ONLY");
|
||||
plan.put("policy", "Review and apply through the approved release process. This file does not execute SQL.");
|
||||
ArrayNode rollback = plan.putArray("rollbackSqlStatements");
|
||||
textValues(deploymentPackage.path("rollbackSqlStatements")).forEach(rollback::add);
|
||||
ArrayNode sourceEvidence = plan.putArray("sourceRunEvidence");
|
||||
if (deploymentPackage.path("runEvidence").isArray()) {
|
||||
deploymentPackage.path("runEvidence").forEach(sourceEvidence::add);
|
||||
}
|
||||
ArrayNode warnings = plan.putArray("warnings");
|
||||
warnings.add("Generated offline; no production SQL was executed.");
|
||||
deploymentPackage.path("warnings").forEach(warning -> warnings.add(warning.asText()));
|
||||
return plan;
|
||||
}
|
||||
|
||||
private void validateRollbackPlanSource(JsonNode payload, JsonNode deploymentPackage, List<String> blockers) {
|
||||
if (!payload.isObject()) {
|
||||
blockers.add("payload 必须是功能包 JSON object");
|
||||
}
|
||||
if (!deploymentPackage.isObject()) {
|
||||
blockers.add("deploymentPackage 必须是 JSON object");
|
||||
return;
|
||||
}
|
||||
if (packageId(payload, deploymentPackage).isBlank()) {
|
||||
blockers.add("packageId 不能为空");
|
||||
}
|
||||
if (!deploymentPackage.path("requiresHumanApproval").asBoolean(false)) {
|
||||
blockers.add("deploymentPackage.requiresHumanApproval 必须是 true");
|
||||
}
|
||||
if (!hasTextArrayItems(deploymentPackage.path("rollbackSqlStatements"))) {
|
||||
blockers.add("rollbackSqlStatements 不能为空");
|
||||
}
|
||||
if (containsPlaceholder(deploymentPackage.path("rollbackSqlStatements"))) {
|
||||
blockers.add("rollbackSqlStatements 仍包含 ${...} 占位符,必须人工替换后再生成回滚计划");
|
||||
}
|
||||
}
|
||||
|
||||
private void validateEnvelope(JsonNode root, List<String> blockers, boolean requireEnvelope) throws IOException {
|
||||
if (!root.has("format")) {
|
||||
if (requireEnvelope) {
|
||||
@@ -265,6 +405,12 @@ public final class Eip4Cli {
|
||||
return validation.blockers().isEmpty() ? 0 : 2;
|
||||
}
|
||||
|
||||
private int printReleaseOperationFailed(String label, List<String> blockers, PrintStream err) {
|
||||
err.println(label + " FAILED");
|
||||
blockers.forEach(blocker -> err.println("- " + blocker));
|
||||
return 2;
|
||||
}
|
||||
|
||||
private int runEnvAdd(String[] args, PrintStream out) throws IOException {
|
||||
Options options = Options.parse(args, 2);
|
||||
String name = requiredPart(options.single("name"), "name");
|
||||
@@ -598,6 +744,68 @@ public final class Eip4Cli {
|
||||
return false;
|
||||
}
|
||||
|
||||
private List<String> textValues(JsonNode node) {
|
||||
List<String> values = new ArrayList<>();
|
||||
if (!node.isArray()) {
|
||||
return values;
|
||||
}
|
||||
for (JsonNode item : node) {
|
||||
String value = item.asText("");
|
||||
if (!value.isBlank()) {
|
||||
values.add(value);
|
||||
}
|
||||
}
|
||||
return values;
|
||||
}
|
||||
|
||||
private ObjectNode textArrayDiff(JsonNode left, JsonNode right) {
|
||||
List<String> leftValues = textValues(left);
|
||||
List<String> rightValues = textValues(right);
|
||||
Set<String> leftSet = new LinkedHashSet<>(leftValues);
|
||||
Set<String> rightSet = new LinkedHashSet<>(rightValues);
|
||||
ObjectNode node = objectMapper.createObjectNode();
|
||||
node.put("leftCount", leftValues.size());
|
||||
node.put("rightCount", rightValues.size());
|
||||
ArrayNode added = node.putArray("added");
|
||||
for (String value : rightSet) {
|
||||
if (!leftSet.contains(value)) {
|
||||
added.add(value);
|
||||
}
|
||||
}
|
||||
ArrayNode removed = node.putArray("removed");
|
||||
for (String value : leftSet) {
|
||||
if (!rightSet.contains(value)) {
|
||||
removed.add(value);
|
||||
}
|
||||
}
|
||||
boolean orderChanged = added.isEmpty() && removed.isEmpty() && !leftValues.equals(rightValues);
|
||||
node.put("orderChanged", orderChanged);
|
||||
node.put("changed", !added.isEmpty() || !removed.isEmpty() || orderChanged);
|
||||
return node;
|
||||
}
|
||||
|
||||
private void putScalarDiff(ObjectNode parent, String field, String left, String right) {
|
||||
ObjectNode node = parent.putObject(field);
|
||||
node.put("left", left);
|
||||
node.put("right", right);
|
||||
node.put("changed", !left.equals(right));
|
||||
}
|
||||
|
||||
private boolean fieldsChanged(ObjectNode fields) {
|
||||
for (JsonNode field : fields) {
|
||||
if (field.path("changed").asBoolean(false)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
private void printArrayDiffSummary(JsonNode diff, PrintStream out, String label) {
|
||||
out.println(label + ": added=" + diff.path("added").size()
|
||||
+ ", removed=" + diff.path("removed").size()
|
||||
+ ", orderChanged=" + diff.path("orderChanged").asBoolean(false));
|
||||
}
|
||||
|
||||
private boolean hasRunEvidence(JsonNode runEvidence, String runType, String status) {
|
||||
if (!runEvidence.isArray()) {
|
||||
return false;
|
||||
@@ -665,8 +873,10 @@ public final class Eip4Cli {
|
||||
eip4 env current
|
||||
eip4 env status [--env NAME|--base-url URL|--all]
|
||||
eip4 ai auto-develop --objective TEXT --feature-name NAME --table-name TABLE --entity-name NAME --template-id ID --menu-name NAME --field column:label:type[:length][:required]
|
||||
eip4 release diff --left FILE --right FILE
|
||||
eip4 release export --package-file FILE --output FILE
|
||||
eip4 release import-preview --package-file FILE
|
||||
eip4 release rollback-plan --package-file FILE --output FILE
|
||||
eip4 release verify --package-file FILE
|
||||
|
||||
Environment:
|
||||
@@ -678,8 +888,10 @@ public final class Eip4Cli {
|
||||
private void printReleaseHelp(PrintStream out) {
|
||||
out.println("""
|
||||
Usage:
|
||||
eip4 release diff --left FILE --right FILE [--json-output]
|
||||
eip4 release export --package-file FILE --output FILE
|
||||
eip4 release import-preview --package-file FILE [--json-output]
|
||||
eip4 release rollback-plan --package-file FILE --output FILE
|
||||
eip4 release verify --package-file FILE [--json-output]
|
||||
""");
|
||||
}
|
||||
|
||||
@@ -316,18 +316,87 @@ class Eip4CliTest {
|
||||
assertTrue(preview.err().contains("checksum 不匹配"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void releaseDiffReportsSqlAndRollbackChanges() throws Exception {
|
||||
Path left = packageFile("left-package.json", "aipkg-left",
|
||||
"insert into sys_page_schema values ('left')",
|
||||
"delete from sys_page_schema where id = 'left'");
|
||||
Path right = packageFile("right-package.json", "aipkg-right",
|
||||
"insert into sys_page_schema values ('right')",
|
||||
"delete from sys_page_schema where id = 'right'");
|
||||
|
||||
CliResult result = run(new CapturingClient(new Eip4HttpResponse(200, "{}")),
|
||||
"release", "diff",
|
||||
"--left", left.toString(),
|
||||
"--right", right.toString(),
|
||||
"--json-output");
|
||||
|
||||
assertEquals(0, result.code());
|
||||
JsonNode report = objectMapper.readTree(result.out());
|
||||
assertTrue(report.path("changed").asBoolean());
|
||||
assertEquals("aipkg-left", report.path("leftPackageId").asText());
|
||||
assertEquals("aipkg-right", report.path("rightPackageId").asText());
|
||||
assertEquals(1, report.path("sqlStatements").path("added").size());
|
||||
assertTrue(report.path("sqlStatements").path("added").get(0).asText().contains("'right'"));
|
||||
assertEquals(1, report.path("rollbackSqlStatements").path("removed").size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void releaseRollbackPlanWritesPlanOnlyArtifact() throws Exception {
|
||||
Path source = validPackageFile("package-source.json");
|
||||
Path planFile = tempDir.resolve("rollback-plan.json");
|
||||
|
||||
CliResult result = run(new CapturingClient(new Eip4HttpResponse(200, "{}")),
|
||||
"release", "rollback-plan",
|
||||
"--package-file", source.toString(),
|
||||
"--output", planFile.toString());
|
||||
|
||||
assertEquals(0, result.code());
|
||||
JsonNode plan = objectMapper.readTree(Files.readString(planFile));
|
||||
assertEquals("EIP4_ROLLBACK_PLAN", plan.path("type").asText());
|
||||
assertEquals("PLAN_ONLY", plan.path("mode").asText());
|
||||
assertEquals("aipkg-1", plan.path("packageId").asText());
|
||||
assertTrue(plan.path("requiresHumanApproval").asBoolean());
|
||||
assertEquals(1, plan.path("rollbackSqlStatements").size());
|
||||
assertTrue(plan.path("policy").asText().contains("does not execute SQL"));
|
||||
assertTrue(result.out().contains("Wrote rollback plan"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void releaseRollbackPlanBlocksRollbackPlaceholders() throws Exception {
|
||||
Path source = packageFile("package-with-rollback-placeholder.json", "aipkg-placeholder",
|
||||
"insert into sys_page_schema values ('x')",
|
||||
"delete from sys_page_schema where id = '${pageSchemaId}'");
|
||||
Path planFile = tempDir.resolve("rollback-plan.json");
|
||||
|
||||
CliResult result = run(new CapturingClient(new Eip4HttpResponse(200, "{}")),
|
||||
"release", "rollback-plan",
|
||||
"--package-file", source.toString(),
|
||||
"--output", planFile.toString());
|
||||
|
||||
assertEquals(2, result.code());
|
||||
assertTrue(result.err().contains("Rollback plan FAILED"));
|
||||
assertTrue(result.err().contains("rollbackSqlStatements 仍包含"));
|
||||
}
|
||||
|
||||
private Path validPackageFile(String name) throws Exception {
|
||||
return packageFile(name, "aipkg-1",
|
||||
"insert into sys_page_schema values ('x')",
|
||||
"delete from sys_page_schema where id = 'x'");
|
||||
}
|
||||
|
||||
private Path packageFile(String name, String packageId, String sql, String rollbackSql) throws Exception {
|
||||
Path file = tempDir.resolve(name);
|
||||
Files.writeString(file, """
|
||||
{
|
||||
"id": "aipkg-1",
|
||||
"id": "%s",
|
||||
"deploymentPackage": {
|
||||
"taskId": "ait-1",
|
||||
"changeSetId": "aics-1",
|
||||
"status": "READY_FOR_HUMAN_REVIEW",
|
||||
"requiresHumanApproval": true,
|
||||
"sqlStatements": ["insert into sys_page_schema values ('x')"],
|
||||
"rollbackSqlStatements": ["delete from sys_page_schema where id = 'x'"],
|
||||
"sqlStatements": [%s],
|
||||
"rollbackSqlStatements": [%s],
|
||||
"warnings": [],
|
||||
"runEvidence": [
|
||||
{"runType": "LOCAL_APPLY", "status": "PASSED"},
|
||||
@@ -335,7 +404,8 @@ class Eip4CliTest {
|
||||
]
|
||||
}
|
||||
}
|
||||
""", StandardCharsets.UTF_8);
|
||||
""".formatted(packageId, objectMapper.writeValueAsString(sql),
|
||||
objectMapper.writeValueAsString(rollbackSql)), StandardCharsets.UTF_8);
|
||||
return file;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user