Skip to content

Allow replacement of simple shape types in ModelTransformer #900

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

Merged
JordonPhillips merged 2 commits into from
Sep 2, 2021
Merged

Allow replacement of simple shape types in ModelTransformer #900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c4bcf7
Allow replacement of simple shape types in ModelTransformer
jdisanti Aug 31, 2021
b57137c
Simplify type replacement validation logic
jdisanti Sep 1, 2021
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
29 changes: 25 additions & 4 deletions smithy-model/src/main/java/software/amazon/smithy/model/transform/ReplaceShapes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@
import java.util.Set;
import java.util.stream.Collectors;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.CollectionShape;
import software.amazon.smithy.model.shapes.ListShape;
import software.amazon.smithy.model.shapes.MapShape;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.SetShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.ShapeVisitor;
import software.amazon.smithy.model.shapes.SimpleShape;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.shapes.UnionShape;
import software.amazon.smithy.utils.OptionalUtils;
Expand Down Expand Up @@ -84,7 +86,7 @@ Model transform(ModelTransformer transformer, Model model) {
return model;
}

assertNoShapeChangedType(model, shouldReplace);
assertShapeTypeChangesSound(model, shouldReplace);
Model.Builder builder = createReplacedModelBuilder(model, shouldReplace);

// If a member shape changes, then ensure that the containing shape
Expand Down Expand Up @@ -121,18 +123,37 @@ private List<Shape> determineShapesToReplace(Model model) {
.collect(toList());
}

private void assertNoShapeChangedType(Model model, List<Shape> shouldReplace) {
private void assertShapeTypeChangesSound(Model model, List<Shape> shouldReplace) {
// Throws if any mappings attempted to change a shape's type.
shouldReplace.stream()
.flatMap(previous -> Pair.flatMapStream(previous, p -> model.getShape(p.getId())))
.filter(pair -> pair.getLeft().getType() != pair.getRight().getType())
.filter(pair -> !isReplacementValid(model, pair.getLeft(), pair.getRight()))
.forEach(pair -> {
throw new RuntimeException(String.format(
throw new IllegalStateException(String.format(
"Cannot change the type of %s from %s to %s",
pair.getLeft().getId(), pair.getLeft().getType(), pair.getRight().getType()));
pair.getLeft().getId(), pair.getRight().getType(), pair.getLeft().getType()));
});
}

private boolean isReplacementValid(Model model, Shape left, Shape right) {
if (left instanceof CollectionShape && right instanceof CollectionShape) {
validateListCollectionReplacement(model, (CollectionShape) left, (CollectionShape) right);
return true;
}
return left instanceof SimpleShape && right instanceof SimpleShape;
}

private void validateListCollectionReplacement(Model model, CollectionShape left, CollectionShape right) {
Shape leftTarget = model.expectShape(left.getMember().getTarget());
Shape rightTarget = model.expectShape(right.getMember().getTarget());
if (!isReplacementValid(model, leftTarget, rightTarget)) {
throw new IllegalStateException(String.format(
"Cannot change the type of %s from %s to %s",
left.getMember().getId(), rightTarget.getType(), leftTarget.getType()));
}
}

private Model.Builder createReplacedModelBuilder(Model model, List<Shape> shouldReplace) {
// Add member shapes to the builder. This builder is mutated
// by the visitor, which will ensure that newly added members
Expand Down
84 changes: 79 additions & 5 deletions smithy-model/src/test/java/software/amazon/smithy/model/transform/ReplaceShapesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,23 @@
package software.amazon.smithy.model.transform;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Arrays;
import java.util.Collections;
import java.util.Optional;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.SourceLocation;
import software.amazon.smithy.model.shapes.IntegerShape;
import software.amazon.smithy.model.shapes.ListShape;
import software.amazon.smithy.model.shapes.LongShape;
import software.amazon.smithy.model.shapes.MapShape;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.SetShape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.StringShape;
import software.amazon.smithy.model.shapes.StructureShape;
Expand All @@ -41,14 +44,85 @@
public class ReplaceShapesTest {

@Test
public void cannotChangeShapeTypes() {
Assertions.assertThrows(RuntimeException.class, () -> {
public void cannotChangeComplexShapeTypes() {
IllegalStateException ex = assertThrows(IllegalStateException.class, () -> {
ShapeId shapeId = ShapeId.from("ns.foo#id1");
StringShape shape = StringShape.builder().id(shapeId).build();
Model model = Model.builder().addShape(shape).build();
Model model = Model.builder()
.addShape(shape)
.addShape(LongShape.builder().id("ns.foo#id2").build())
.build();
ModelTransformer transformer = ModelTransformer.create();
transformer.mapShapes(model, s -> IntegerShape.builder().id(shapeId).build());
transformer.mapShapes(model, s -> {
if (s.getId().equals(shapeId)) {
return StructureShape.builder()
.id(shapeId)
.addMember(
MemberShape.builder()
.id(ShapeId.from("ns.foo#id1$member1"))
.target("ns.foo#id2")
.build()
).build();
}
return s;
});
});
assertEquals("Cannot change the type of ns.foo#id1 from string to structure", ex.getMessage());
}

@Test
public void canChangeSimpleShapeTypes() {
ShapeId shapeId = ShapeId.from("ns.foo#id1");
IntegerShape shape = IntegerShape.builder().id(shapeId).build();
Model model = Model.builder().addShape(shape).build();
ModelTransformer transformer = ModelTransformer.create();
transformer.mapShapes(model, s -> LongShape.builder().id(shapeId).build());
}

@Test
public void canExchangeSimilarListCollectionTypes() {
ShapeId shapeId = ShapeId.from("ns.foo#id1");
ListShape shape = ListShape.builder().id(shapeId).member(ShapeId.from("smithy.api#Long")).build();
Model model = Model.builder()
.addShape(shape)
.addShape(LongShape.builder().id(ShapeId.from("smithy.api#Long")).build())
.build();
ModelTransformer transformer = ModelTransformer.create();
transformer.mapShapes(model, s -> {
if (s.getId().equals(shapeId)) {
return SetShape.builder().id(shapeId).member(ShapeId.from("smithy.api#Long")).build();
}
return s;
});
}

@Test
public void canNotExchangeListCollectionTypesWithNonReplaceableMembers() {
ShapeId shapeId = ShapeId.from("ns.foo#id1");
ShapeId structId = ShapeId.from("ns.foo#id2");
ListShape shape = ListShape.builder().id(shapeId).member(ShapeId.from("smithy.api#Long")).build();
Model model = Model.builder()
.addShape(shape)
.addShape(LongShape.builder().id(ShapeId.from("smithy.api#Long")).build())
.addShape(StructureShape.builder()
.id(structId)
.addMember(
MemberShape.builder()
.id(structId.withMember("member1"))
.target("smithy.api#Long")
.build()
).build())
.build();
IllegalStateException ex = assertThrows(IllegalStateException.class, () -> {
ModelTransformer transformer = ModelTransformer.create();
transformer.mapShapes(model, s -> {
if (s.getId().equals(shapeId)) {
return SetShape.builder().id(shapeId).member(structId).build();
}
return s;
});
});
assertEquals("Cannot change the type of ns.foo#id1$member from long to structure", ex.getMessage());
}

@Test
Expand Down