-
Notifications
You must be signed in to change notification settings - Fork 916
Added support for endpoint variants in endpoint metadata: FIPS and DUALSTACK. #2808
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
206 changes: 206 additions & 0 deletions
206
...-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/EndpointTagGenerator.java
This file contains hidden or 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,206 @@ | ||
| /* | ||
| * Copyright 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.awssdk.codegen.lite.regions; | ||
|
|
||
| import static javax.lang.model.element.Modifier.FINAL; | ||
| import static javax.lang.model.element.Modifier.PRIVATE; | ||
| import static javax.lang.model.element.Modifier.PUBLIC; | ||
| import static javax.lang.model.element.Modifier.STATIC; | ||
|
|
||
| import com.squareup.javapoet.AnnotationSpec; | ||
| import com.squareup.javapoet.ClassName; | ||
| import com.squareup.javapoet.CodeBlock; | ||
| import com.squareup.javapoet.FieldSpec; | ||
| import com.squareup.javapoet.MethodSpec; | ||
| import com.squareup.javapoet.ParameterizedTypeName; | ||
| import com.squareup.javapoet.TypeName; | ||
| import com.squareup.javapoet.TypeSpec; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import java.util.TreeSet; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import software.amazon.awssdk.annotations.Generated; | ||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.codegen.lite.PoetClass; | ||
| import software.amazon.awssdk.codegen.lite.regions.model.Endpoint; | ||
| import software.amazon.awssdk.codegen.lite.regions.model.Partition; | ||
| import software.amazon.awssdk.codegen.lite.regions.model.Partitions; | ||
| import software.amazon.awssdk.codegen.lite.regions.model.Service; | ||
| import software.amazon.awssdk.utils.StringUtils; | ||
| import software.amazon.awssdk.utils.internal.CodegenNamingUtils; | ||
|
|
||
| public class EndpointTagGenerator implements PoetClass { | ||
| private final Partitions partitions; | ||
| private final String basePackage; | ||
|
|
||
| public EndpointTagGenerator(Partitions partitions, | ||
| String basePackage) { | ||
| this.partitions = partitions; | ||
| this.basePackage = basePackage; | ||
| } | ||
|
|
||
| @Override | ||
| public TypeSpec poetClass() { | ||
| TypeSpec.Builder builder = TypeSpec.classBuilder(className()) | ||
| .addModifiers(FINAL, PUBLIC) | ||
| .addJavadoc(documentation()) | ||
| .addAnnotation(SdkPublicApi.class) | ||
| .addAnnotation(AnnotationSpec.builder(Generated.class) | ||
| .addMember("value", | ||
| "$S", | ||
| "software.amazon.awssdk:codegen") | ||
| .build()) | ||
| .addMethod(MethodSpec.constructorBuilder() | ||
| .addModifiers(PRIVATE) | ||
| .addParameter(String.class, "id") | ||
| .addStatement("this.id = id") | ||
| .build()); | ||
| endpointTags(builder); | ||
|
|
||
| builder.addField(FieldSpec.builder(String.class, "id") | ||
| .addModifiers(FINAL, PRIVATE) | ||
| .build()) | ||
| .addMethod(tagOf()) | ||
| .addMethod(tagGetter()) | ||
| .addMethod(id()) | ||
| .addMethod(tagToString()); | ||
|
|
||
| return builder.addType(cache()).build(); | ||
| } | ||
|
|
||
| private void endpointTags(TypeSpec.Builder builder) { | ||
| Stream<Endpoint> endpointsFromPartitions = partitions.getPartitions().stream().map(Partition::getDefaults); | ||
| Stream<Endpoint> endpointsFromServices = partitions.getPartitions().stream() | ||
| .flatMap(p -> p.getServices().values().stream()) | ||
| .flatMap(s -> s.getEndpoints().values().stream()); | ||
| Stream<Endpoint> endpointsFromServiceDefaults = partitions.getPartitions().stream() | ||
| .flatMap(p -> p.getServices().values().stream()) | ||
| .map(Service::getDefaults) | ||
| .filter(Objects::nonNull); | ||
|
|
||
| Set<String> allTags = | ||
| Stream.concat(endpointsFromPartitions, Stream.concat(endpointsFromServices, endpointsFromServiceDefaults)) | ||
| .flatMap(e -> e.getVariants().stream()) | ||
| .flatMap(v -> v.getTags().stream()) | ||
| .collect(Collectors.toCollection(TreeSet::new)); | ||
|
|
||
| // Add each tag as a separate entry in the endpoint tags | ||
| allTags.forEach(tag -> builder.addField(FieldSpec.builder(className(), enumValueForTagId(tag)) | ||
| .addModifiers(PUBLIC, STATIC, FINAL) | ||
| .initializer("$T.of($S)", className(), tag) | ||
| .build())); | ||
|
|
||
| String tagsCodeBlock = allTags.stream() | ||
| .map(this::enumValueForTagId) | ||
| .collect(Collectors.joining(", ")); | ||
|
|
||
| CodeBlock initializer = CodeBlock.builder() | ||
| .add("$T.unmodifiableList($T.asList(", Collections.class, Arrays.class) | ||
| .add(tagsCodeBlock) | ||
| .add("))") | ||
| .build(); | ||
|
|
||
| TypeName listOfTags = ParameterizedTypeName.get(ClassName.get(List.class), className()); | ||
| builder.addField(FieldSpec.builder(listOfTags, "ENDPOINT_TAGS") | ||
| .addModifiers(PRIVATE, STATIC, FINAL) | ||
| .initializer(initializer) | ||
| .build()); | ||
| } | ||
|
|
||
| private String enumValueForTagId(String tag) { | ||
| return Stream.of(CodegenNamingUtils.splitOnWordBoundaries(tag)) | ||
| .map(StringUtils::upperCase) | ||
| .collect(Collectors.joining("_")); | ||
| } | ||
|
|
||
| private MethodSpec tagOf() { | ||
| return MethodSpec.methodBuilder("of") | ||
| .addModifiers(PUBLIC, STATIC) | ||
| .addParameter(String.class, "id") | ||
| .returns(className()) | ||
| .addStatement("return EndpointTagCache.put($L)", "id") | ||
| .build(); | ||
|
|
||
| } | ||
|
|
||
| private MethodSpec id() { | ||
| return MethodSpec.methodBuilder("id") | ||
| .addModifiers(PUBLIC) | ||
| .returns(String.class) | ||
| .addStatement("return this.id") | ||
| .build(); | ||
| } | ||
|
|
||
| private MethodSpec tagGetter() { | ||
| return MethodSpec.methodBuilder("endpointTags") | ||
| .addModifiers(PUBLIC, STATIC) | ||
| .returns(ParameterizedTypeName.get(ClassName.get(List.class), | ||
| className())) | ||
| .addStatement("return $L", "ENDPOINT_TAGS") | ||
| .build(); | ||
| } | ||
|
|
||
| private MethodSpec tagToString() { | ||
| return MethodSpec.methodBuilder("toString") | ||
| .addAnnotation(Override.class) | ||
| .addModifiers(PUBLIC) | ||
| .returns(String.class) | ||
| .addStatement("return $L", "id") | ||
| .build(); | ||
| } | ||
|
|
||
| private TypeSpec cache() { | ||
| ParameterizedTypeName mapOfStringTags = ParameterizedTypeName.get(ClassName.get(ConcurrentHashMap.class), | ||
| ClassName.get(String.class), | ||
| className()); | ||
|
|
||
| return TypeSpec.classBuilder("EndpointTagCache") | ||
| .addModifiers(PRIVATE, STATIC) | ||
| .addField(FieldSpec.builder(mapOfStringTags, "IDS") | ||
| .addModifiers(PRIVATE, STATIC, FINAL) | ||
| .initializer("new $T<>()", ConcurrentHashMap.class) | ||
| .build()) | ||
|
|
||
| .addMethod(MethodSpec.constructorBuilder().addModifiers(PRIVATE).build()) | ||
| .addMethod(MethodSpec.methodBuilder("put") | ||
| .addModifiers(PRIVATE, STATIC) | ||
| .addParameter(String.class, "id") | ||
| .returns(className()) | ||
| .addStatement("return $L.computeIfAbsent(id, $T::new)", | ||
| "IDS", | ||
| className()) | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| private CodeBlock documentation() { | ||
| return CodeBlock.builder() | ||
| .add("A tag applied to endpoints to specify that they're to be used in certain contexts. For example, " | ||
| + "FIPS tags are applied to endpoints discussed here: https://aws.amazon.com/compliance/fips/ and " | ||
| + "DUALSTACK tags are applied to endpoints that can return IPv6 addresses.") | ||
| .build(); | ||
| } | ||
|
|
||
| @Override | ||
| public ClassName className() { | ||
| return ClassName.get(basePackage, "EndpointTag"); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a test to generate EndpointTag? It's hard to tell what EndpointTag looks like from codegen code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done