-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow jsonName trait on union members
Closes #953
- Loading branch information
Showing
8 changed files
with
280 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
...l/src/main/java/software/amazon/smithy/model/validation/validators/JsonNameValidator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.smithy.model.validation.validators; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.TreeMap; | ||
| import java.util.TreeSet; | ||
| import java.util.stream.Collectors; | ||
| import software.amazon.smithy.model.Model; | ||
| import software.amazon.smithy.model.shapes.MemberShape; | ||
| import software.amazon.smithy.model.shapes.Shape; | ||
| import software.amazon.smithy.model.shapes.ShapeId; | ||
| import software.amazon.smithy.model.traits.JsonNameTrait; | ||
| import software.amazon.smithy.model.validation.AbstractValidator; | ||
| import software.amazon.smithy.model.validation.ValidationEvent; | ||
|
|
||
| public final class JsonNameValidator extends AbstractValidator { | ||
| @Override | ||
| public List<ValidationEvent> validate(Model model) { | ||
| List<ValidationEvent> events = new ArrayList<>(); | ||
| Set<ShapeId> visitedContainers = new HashSet<>(); | ||
|
|
||
| // Find every member marked with a jsonName trait. The containing shapes of these members are | ||
| // the only structure/union shapes that need to be validated. | ||
| for (MemberShape member : model.getMemberShapesWithTrait(JsonNameTrait.class)) { | ||
| // If the container hasn't been visited yet, then validate it's members. | ||
| if (visitedContainers.add(member.getContainer())) { | ||
| validateMembersOfContainer(model.expectShape(member.getContainer()), events); | ||
| } | ||
| } | ||
| return events; | ||
| } | ||
|
|
||
| private void validateMembersOfContainer(Shape container, List<ValidationEvent> events) { | ||
| Map<String, Set<MemberShape>> memberMappings = new TreeMap<>(); | ||
| for (MemberShape m : container.members()) { | ||
| String jsonName = m.getTrait(JsonNameTrait.class) | ||
| .map(JsonNameTrait::getValue) | ||
| .orElseGet(m::getMemberName); | ||
| memberMappings.computeIfAbsent(jsonName, n -> new TreeSet<>()).add(m); | ||
| } | ||
|
|
||
| for (Map.Entry<String, Set<MemberShape>> entry : memberMappings.entrySet()) { | ||
| if (entry.getValue().size() > 1) { | ||
| events.add(error(container, String.format( | ||
| "This shape contains members with conflicting JSON names that resolve to '%s': %s", | ||
| entry.getKey(), | ||
| entry.getValue().stream().map(MemberShape::getMemberName).collect(Collectors.joining(", "))))); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...el/src/test/resources/software/amazon/smithy/model/errorfiles/validators/json-name.errors
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| [ERROR] ns.foo#B: Trait `jsonName` cannot be applied to `ns.foo#B`. This trait may only be applied to shapes that match the following selector: structure > member | TraitTarget | ||
| [ERROR] ns.foo#B: Trait `jsonName` cannot be applied to `ns.foo#B`. This trait may only be applied to shapes that match the following selector: :is(structure, union) | TraitTarget |
2 changes: 2 additions & 0 deletions
2
...est/resources/software/amazon/smithy/model/errorfiles/validators/jsonName-conflict.errors
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [ERROR] ns.foo#A: This shape contains members with conflicting JSON names that resolve to 'b': a, b | JsonName | ||
| [ERROR] ns.foo#B: This shape contains members with conflicting JSON names that resolve to 'b': a, b | JsonName |
45 changes: 45 additions & 0 deletions
45
.../test/resources/software/amazon/smithy/model/errorfiles/validators/jsonName-conflict.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| { | ||
| "smithy": "1.0", | ||
| "shapes": { | ||
| "ns.foo#A": { | ||
| "type": "structure", | ||
| "members": { | ||
| "a": { | ||
| "target": "smithy.api#String", | ||
| "traits": { | ||
| "smithy.api#jsonName": "b" | ||
| } | ||
| }, | ||
| "b": { | ||
| "target": "smithy.api#String" | ||
| }, | ||
| "c": { | ||
| "target": "smithy.api#String", | ||
| "traits": { | ||
| "smithy.api#jsonName": "a" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "ns.foo#B": { | ||
| "type": "union", | ||
| "members": { | ||
| "a": { | ||
| "target": "smithy.api#String", | ||
| "traits": { | ||
| "smithy.api#jsonName": "b" | ||
| } | ||
| }, | ||
| "b": { | ||
| "target": "smithy.api#String" | ||
| }, | ||
| "c": { | ||
| "target": "smithy.api#String", | ||
| "traits": { | ||
| "smithy.api#jsonName": "a" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |