Skip to content

Release endpoint variants: dualstack and fips for all services. #2830

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

Merged
merged 4 commits into from
Nov 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .brazil.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"protocol-tests": { "skipImport": true },
"protocol-tests-core": { "skipImport": true },
"protocols": { "skipImport": true },
"region-testing": { "skipImport": true },
"release-scripts": { "skipImport": true },
"s3-benchmarks": { "skipImport": true },
"sdk-benchmarks": { "skipImport": true },
Expand Down
6 changes: 6 additions & 0 deletions .changes/next-release/deprecation-AmazonS3-21b2ad3.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "Amazon S3",
"contributor": "",
"type": "deprecation",
"description": "Deprecated `S3Configuration.Builder`'s `dualstackEnabled` in favor of the new service-standard `S3ClientBuilder.dualstackEnabled`."
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "Amazon S3 Control",
"contributor": "",
"type": "deprecation",
"description": "Deprecated `S3ControlConfiguration.Builder`'s `dualstackEnabled` in favor of the new service-standard `S3ControlClientBuilder.dualstackEnabled`."
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "Amazon S3 Control",
"contributor": "",
"type": "deprecation",
"description": "Deprecated `S3ControlConfiguration.Builder`'s `fipsModeEnabled` in favor of the new service-standard `S3ControlClientBuilder.fipsEnabled`."
}
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AWSSDKforJava-6255065.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "AWS SDK for Java",
"contributor": "",
"type": "feature",
"description": "Added a new `dualstackEnabled` property to every client builder, which can be used to make calls be invoked against AWS endpoints which return IPv6 records. This can also be enabled via the `AWS_USE_DUALSTACK_ENDPOINT` environment variable, `aws.useDualstackEndpoint` system property, or the `use_dualstack_endpoint` profile file property."
}
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AWSSDKforJavav2-635c382.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "AWS SDK for Java v2",
"contributor": "",
"type": "feature",
"description": "Added a new `fipsEnabled` property to every client builder, which can be used to make calls be invoked against AWS endpoints which are FIPS compliant. This can also be enabled via the `AWS_USE_FIPS_ENDPOINT` environment variable, `aws.useFipsEndpoint` system property, or the `use_fips_endpoint` profile file property."
}
2 changes: 1 addition & 1 deletion buildspecs/release-to-maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ phases:
awk 'BEGIN { var=ENVIRON["SDK_SIGNING_GPG_KEYNAME"] } { gsub("\\$SDK_SIGNING_GPG_KEYNAME", var, $0); print }' > \
$SETTINGS_XML

mvn clean deploy -B -s $SETTINGS_XML -Ppublishing -DperformRelease -Dspotbugs.skip -DskipTests -Dcheckstyle.skip -Djapicmp.skip -Ddoclint=none -pl !:protocol-tests,!:protocol-tests-core,!:codegen-generated-classes-test,!:sdk-benchmarks,!:module-path-tests,!:tests-coverage-reporting,!:stability-tests,!:sdk-native-image-test,!:auth-sts-testing,!:s3-benchmarks -DautoReleaseAfterClose=true -DstagingProgressTimeoutMinutes=30
mvn clean deploy -B -s $SETTINGS_XML -Ppublishing -DperformRelease -Dspotbugs.skip -DskipTests -Dcheckstyle.skip -Djapicmp.skip -Ddoclint=none -pl !:protocol-tests,!:protocol-tests-core,!:codegen-generated-classes-test,!:sdk-benchmarks,!:module-path-tests,!:tests-coverage-reporting,!:stability-tests,!:sdk-native-image-test,!:auth-sts-testing,!:s3-benchmarks,!:region-testing -DautoReleaseAfterClose=true -DstagingProgressTimeoutMinutes=30
else
echo "This version was already released."
fi
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import software.amazon.awssdk.codegen.lite.CodeGenerator;
import software.amazon.awssdk.codegen.lite.regions.EndpointTagGenerator;
import software.amazon.awssdk.codegen.lite.regions.PartitionMetadataGenerator;
import software.amazon.awssdk.codegen.lite.regions.PartitionMetadataProviderGenerator;
import software.amazon.awssdk.codegen.lite.regions.RegionGenerator;
Expand Down Expand Up @@ -71,6 +72,7 @@ public void execute() throws MojoExecutionException {
generatePartitionProvider(baseSourcesDirectory, partitions);
generateRegionProvider(baseSourcesDirectory, partitions);
generateServiceProvider(baseSourcesDirectory, partitions);
generateEndpointTags(baseSourcesDirectory, partitions);

project.addCompileSourceRoot(baseSourcesDirectory.toFile().getAbsolutePath());
project.addTestCompileSourceRoot(testsDirectory.toFile().getAbsolutePath());
Expand Down Expand Up @@ -138,4 +140,9 @@ public void generateServiceProvider(Path baseSourcesDirectory, Partitions partit
REGION_BASE))
.generate();
}

public void generateEndpointTags(Path baseSourcesDirectory, Partitions partitions) {
Path sourcesDirectory = baseSourcesDirectory.resolve(REGION_BASE.replace(".", "/"));
new CodeGenerator(sourcesDirectory.toString(), new EndpointTagGenerator(partitions, REGION_BASE)).generate();
}
}
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");
}
}
Loading