Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Emit specific ids for ChangedEnumTrait ERROR events #1787

Merged
merged 2 commits into from
May 24, 2023
+61 −25
Merged

Emit specific ids for ChangedEnumTrait ERROR events #1787

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9b786a
Emit id 'ChangedEnumTrait.Inserted' for inserted enum diff events
rchache May 24, 2023
1c2ebb9
Changed .Inserted to .OrderChanged, and added subparts for .Removed a…
rchache May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import software.amazon.smithy.model.traits.EnumDefinition;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait;
import software.amazon.smithy.model.validation.Severity;
import software.amazon.smithy.model.validation.ValidationEvent;
import software.amazon.smithy.utils.OptionalUtils;
import software.amazon.smithy.utils.Pair;
Expand All @@ -38,6 +39,8 @@
* list of existing values.
*/
public final class ChangedEnumTrait extends AbstractDiffEvaluator {
private static final String INSERTED = "Inserted";

@Override
public List<ValidationEvent> evaluate(Differences differences) {
return differences.changedShapes()
Expand Down Expand Up @@ -93,10 +96,17 @@ private List<ValidationEvent> validateEnum(ChangedShape<Shape> change, Pair<Enum
for (EnumDefinition definition : newTrait.getValues()) {
if (!oldTrait.getEnumDefinitionValues().contains(definition.getValue())) {
if (newPosition <= oldEndPosition) {
events.add(error(change.getNewShape(), String.format(
"Enum value `%s` was inserted before the end of the list of existing values. This can "
+ "cause compatibility issues when ordinal values are used for iteration, "
+ "serialization, etc.", definition.getValue())));
events.add(
ValidationEvent.builder()
.severity(Severity.ERROR)
.message(String.format(
"Enum value `%s` was inserted before the end of the list of existing values. This "
+ "can cause compatibility issues when ordinal values are used for "
+ "iteration, serialization, etc.", definition.getValue()))
.shape(change.getNewShape())
.id(getEventId() + "." + INSERTED)
rchache marked this conversation as resolved.
Show resolved Hide resolved
.build()
);
} else {
events.add(note(change.getNewShape(), String.format(
"Enum value `%s` was appended", definition.getValue())));
Expand Down
9 changes: 5 additions & 4 deletions smithy-diff/src/test/java/software/amazon/smithy/diff/evaluators/ChangedEnumTraitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ public void detectsInsertedEnums() {
Model modelB = Model.assembler().addShape(s2).assemble().unwrap();
List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);

assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").get(0).getSeverity(), equalTo(Severity.ERROR));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait.Inserted").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait.Inserted").get(0).getSeverity(), equalTo(Severity.ERROR));
}

@Test
Expand All @@ -293,6 +293,7 @@ public void detectsInsertedEnumsEnumTraitNoNameToEnumShape() {
List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);

assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").size(), equalTo(2));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait.Inserted").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").stream()
.allMatch(e -> e.getSeverity() == Severity.ERROR), equalTo(true));
}
Expand All @@ -317,8 +318,8 @@ public void detectsInsertedEnumsEnumTraitWithNameToEnumShape() {
Model modelB = Model.assembler().addShape(s2).assemble().unwrap();
List<ValidationEvent> events = ModelDiff.compare(modelA, modelB);

assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait").stream()
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait.Inserted").size(), equalTo(1));
assertThat(TestHelper.findEvents(events, "ChangedEnumTrait.Inserted").stream()
.allMatch(e -> e.getSeverity() == Severity.ERROR), equalTo(true));
}

Expand Down