Add hierarchical ids for ChangedOperation[I|O] diff events

Author: kstich

smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ChangedOperationInput.java

@@ -19,12 +19,21 @@ public final class ChangedOperationInput extends AbstractDiffEvaluator {
     public List<ValidationEvent> evaluate(Differences differences) {
         return differences.changedShapes(OperationShape.class)
                 .filter(change -> !change.getOldShape().getInputShape().equals(change.getNewShape().getInputShape()))
-                .map(change -> error(change.getNewShape(),
-                        String.format(
-                                "Changed operation input of `%s` from `%s` to `%s`",
-                                change.getShapeId(),
-                                change.getOldShape().getInputShape(),
-                                change.getNewShape().getInputShape())))
+                .map(change -> {
+                    ValidationEvent.Builder eventBuilder = error(change.getNewShape(),
+                            String.format(
+                                    "Changed operation input of `%s` from `%s` to `%s`",
+                                    change.getShapeId(),
+                                    change.getOldShape().getInputShape(),
+                                    change.getNewShape().getInputShape()))
+                            .toBuilder();
+                    return eventBuilder
+                            .id(String.format("%s.From.%s.To.%s",
+                                    getEventId(),
+                                    change.getOldShape().getInputShape(),
+                                    change.getNewShape().getInputShape()))
+                            .build();
+                })
                 .collect(Collectors.toList());
     }
 }

smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ChangedOperationOutput.java

@@ -19,12 +19,21 @@ public final class ChangedOperationOutput extends AbstractDiffEvaluator {
     public List<ValidationEvent> evaluate(Differences differences) {
         return differences.changedShapes(OperationShape.class)
                 .filter(change -> !change.getOldShape().getOutputShape().equals(change.getNewShape().getOutputShape()))
-                .map(change -> error(change.getNewShape(),
-                        String.format(
-                                "Changed operation output of `%s` from `%s` to `%s`",
-                                change.getShapeId(),
-                                change.getOldShape().getOutputShape(),
-                                change.getNewShape().getOutputShape())))
+                .map(change -> {
+                    ValidationEvent.Builder eventBuilder = error(change.getNewShape(),
+                            String.format(
+                                    "Changed operation output of `%s` from `%s` to `%s`",
+                                    change.getShapeId(),
+                                    change.getOldShape().getOutputShape(),
+                                    change.getNewShape().getOutputShape()))
+                            .toBuilder();
+                    return eventBuilder
+                            .id(String.format("%s.From.%s.To.%s",
+                                    getEventId(),
+                                    change.getOldShape().getOutputShape(),
+                                    change.getNewShape().getOutputShape()))
+                            .build();
+                })
                 .collect(Collectors.toList());
     }
 }

smithy-diff/src/test/java/software/amazon/smithy/diff/evaluators/ChangedOperationInputTest.java

@@ -27,6 +27,24 @@ public void detectWhenOperationInputIsChanged() {
         Model modelB = Model.assembler().addShapes(o2, b).assemble().unwrap();
         List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);
 
-        assertThat(TestHelper.findEvents(events, "ChangedOperationInput").size(), equalTo(1));
+        List<ValidationEvent> expectedEvents = TestHelper.findEvents(events, "ChangedOperationInput");
+        assertThat(expectedEvents.size(), equalTo(1));
+        ValidationEvent event = expectedEvents.get(0);
+        assertThat(event.getId(), equalTo("ChangedOperationInput.From.foo.baz#A.To.foo.baz#B"));
+    }
+
+    @Test
+    public void detectWhenOperationInputIsAdded() {
+        OperationShape o1 = OperationShape.builder().id("foo.baz#Bar").build();
+        OperationShape o2 = OperationShape.builder().id("foo.baz#Bar").input(ShapeId.from("foo.baz#B")).build();
+        StructureShape b = StructureShape.builder().id("foo.baz#B").build();
+        Model modelA = Model.assembler().addShapes(o1).assemble().unwrap();
+        Model modelB = Model.assembler().addShapes(o2, b).assemble().unwrap();
+        List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);
+
+        List<ValidationEvent> expectedEvents = TestHelper.findEvents(events, "ChangedOperationInput");
+        assertThat(expectedEvents.size(), equalTo(1));
+        ValidationEvent event = expectedEvents.get(0);
+        assertThat(event.getId(), equalTo("ChangedOperationInput.From.smithy.api#Unit.To.foo.baz#B"));
     }
 }

smithy-diff/src/test/java/software/amazon/smithy/diff/evaluators/ChangedOperationOutputTest.java

@@ -27,6 +27,24 @@ public void detectWhenOperationOutputIsChanged() {
         Model modelB = Model.assembler().addShapes(o2, b).assemble().unwrap();
         List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);
 
-        assertThat(TestHelper.findEvents(events, "ChangedOperationOutput").size(), equalTo(1));
+        List<ValidationEvent> expectedEvents = TestHelper.findEvents(events, "ChangedOperationOutput");
+        assertThat(expectedEvents.size(), equalTo(1));
+        ValidationEvent event = expectedEvents.get(0);
+        assertThat(event.getId(), equalTo("ChangedOperationOutput.From.foo.baz#A.To.foo.baz#B"));
+    }
+
+    @Test
+    public void detectWhenOperationOutputIsAdded() {
+        OperationShape o1 = OperationShape.builder().id("foo.baz#Bar").build();
+        OperationShape o2 = OperationShape.builder().id("foo.baz#Bar").output(ShapeId.from("foo.baz#B")).build();
+        StructureShape b = StructureShape.builder().id("foo.baz#B").build();
+        Model modelA = Model.assembler().addShapes(o1).assemble().unwrap();
+        Model modelB = Model.assembler().addShapes(o2, b).assemble().unwrap();
+        List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);
+
+        List<ValidationEvent> expectedEvents = TestHelper.findEvents(events, "ChangedOperationOutput");
+        assertThat(expectedEvents.size(), equalTo(1));
+        ValidationEvent event = expectedEvents.get(0);
+        assertThat(event.getId(), equalTo("ChangedOperationOutput.From.smithy.api#Unit.To.foo.baz#B"));
     }
 }