From a4d019aa779177e59f7f36bcd5ed636696d0e950 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 29 Aug 2023 13:27:36 +0200 Subject: [PATCH 01/45] Starting by splitting SSM provider out --- .../powertools-examples-parameters/pom.xml | 2 +- .../demo/parameters/ParametersFunction.java | 6 +- pom.xml | 2 + powertools-parameters/pom.xml | 19 +-- .../powertools-parameters-ssm/pom.xml | 116 ++++++++++++++++++ .../parameters/ssm}/SSMProvider.java | 22 ++-- .../parameters/ssm}/SSMProviderTest.java | 64 +++++----- .../powertools-parameters-tests/pom.xml | 64 ++++++++++ .../parameters/AppConfigProviderTest.java | 0 .../parameters/BaseProviderTest.java | 0 .../parameters/DynamoDbProviderE2ETest.java | 0 .../parameters/DynamoDbProviderTest.java | 0 .../LambdaParametersAspectTest.java | 33 ++--- .../ParamManagerIntegrationTest.java | 10 +- .../parameters/ParamManagerTest.java | 10 -- .../parameters/SecretsProviderTest.java | 0 .../parameters/cache/CacheManagerTest.java | 0 .../parameters/cache/DataStoreTest.java | 0 .../parameters/internal/AnotherObject.java | 0 .../parameters/internal/CustomProvider.java | 0 .../transform/Base64TransformerTest.java | 0 .../transform/JsonTransformerTest.java | 0 .../transform/ObjectToDeserialize.java | 0 .../transform/TransformationManagerTest.java | 0 .../lambda/powertools/parameters/Param.java | 2 +- .../powertools/parameters/ParamManager.java | 27 +--- 26 files changed, 258 insertions(+), 119 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-ssm/pom.xml rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm}/SSMProvider.java (95%) rename powertools-parameters/{src/test/java/software/amazon/lambda/powertools/parameters => powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm}/SSMProviderTest.java (74%) create mode 100644 powertools-parameters/powertools-parameters-tests/pom.xml rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java (100%) rename powertools-parameters/{src/test/java/software/amazon/lambda/powertools/parameters/internal => powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters}/LambdaParametersAspectTest.java (74%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java (93%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java (92%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/cache/CacheManagerTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/cache/DataStoreTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/internal/AnotherObject.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/transform/Base64TransformerTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/transform/JsonTransformerTest.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/transform/ObjectToDeserialize.java (100%) rename powertools-parameters/{ => powertools-parameters-tests}/src/test/java/software/amazon/lambda/powertools/parameters/transform/TransformationManagerTest.java (100%) diff --git a/examples/powertools-examples-parameters/pom.xml b/examples/powertools-examples-parameters/pom.xml index 19be585a5..03b9e4dad 100644 --- a/examples/powertools-examples-parameters/pom.xml +++ b/examples/powertools-examples-parameters/pom.xml @@ -21,7 +21,7 @@ software.amazon.lambda - powertools-parameters + powertools-parameters-ssm ${project.version} diff --git a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java index 5b691cfd9..5dfec8031 100644 --- a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java +++ b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java @@ -32,13 +32,15 @@ import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import software.amazon.lambda.powertools.parameters.ParamManager; -import software.amazon.lambda.powertools.parameters.SSMProvider; +import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; import software.amazon.lambda.powertools.parameters.SecretsProvider; public class ParametersFunction implements RequestHandler { private final static Logger log = LogManager.getLogger(ParametersFunction.class); - SSMProvider ssmProvider = ParamManager.getSsmProvider(); + SSMProvider ssmProvider = SSMProvider + .builder() + .build(); SecretsProvider secretsProvider = ParamManager.getSecretsProvider(); String simpleValue = ssmProvider.defaultMaxAge(30, SECONDS).get("/powertools-java/sample/simplekey"); diff --git a/pom.xml b/pom.xml index 17fb1a712..e9465fd41 100644 --- a/pom.xml +++ b/pom.xml @@ -54,6 +54,8 @@ powertools-e2e-tests powertools-batch examples + powertools-parameters/powertools-parameters-ssm + powertools-parameters/powertools-parameters-tests diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml index a703bf36b..95ec9cd6b 100644 --- a/powertools-parameters/pom.xml +++ b/powertools-parameters/pom.xml @@ -28,9 +28,8 @@ Powertools for AWS Lambda (Java) library Parameters - - Set of utilities to retrieve parameters from Secrets Manager or SSM Parameter Store - + Set of utilities to retrieve parameters - common interface + https://aws.amazon.com/lambda/ GitHub Issues @@ -59,20 +58,6 @@ software.amazon.lambda powertools-common - - software.amazon.awssdk - ssm - - - software.amazon.awssdk - apache-client - - - software.amazon.awssdk - netty-nio-client - - - software.amazon.awssdk secretsmanager diff --git a/powertools-parameters/powertools-parameters-ssm/pom.xml b/powertools-parameters/powertools-parameters-ssm/pom.xml new file mode 100644 index 000000000..fae952999 --- /dev/null +++ b/powertools-parameters/powertools-parameters-ssm/pom.xml @@ -0,0 +1,116 @@ + + + 4.0.0 + + + software.amazon.lambda + powertools-parent + 2.0.0-SNAPSHOT + ../../pom.xml + + + powertools-parameters-ssm + Powertools for AWS Lambda (Java) library Parameters - SSM + SSM Parameter Store implementation for the Parameters module + + + GitHub Issues + https://github.com/aws-powertools/powertools-lambda-java/issues + + + https://github.com/aws-powertools/powertools-lambda-java.git + + + + Powertools for AWS Lambda team + Amazon Web Services + https://aws.amazon.com/ + + + + + + ossrh + https://aws.oss.sonatype.org/content/repositories/snapshots + + + + + + software.amazon.lambda + powertools-parameters + ${project.version} + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-core + test + + + org.mockito + mockito-inline + test + + + org.apache.commons + commons-lang3 + test + + + org.assertj + assertj-core + test + + + org.aspectj + aspectjweaver + test + + + software.amazon.awssdk + ssm + + + software.amazon.awssdk + apache-client + + + software.amazon.awssdk + netty-nio-client + + + + + + + + + maven-surefire-plugin + 3.1.2 + + + eu-central-1 + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + \ No newline at end of file diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java similarity index 95% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SSMProvider.java rename to powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java index 10bb70c15..7f308228d 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SSMProvider.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.ssm; import java.time.temporal.ChronoUnit; import java.util.HashMap; @@ -28,6 +28,8 @@ import software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse; import software.amazon.awssdk.utils.StringUtils; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.ParamManager; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; import software.amazon.lambda.powertools.parameters.transform.Transformer; @@ -89,17 +91,6 @@ public class SSMProvider extends BaseProvider { this.client = client; } - /** - * Constructor with only a CacheManager
- *

- * Used in {@link ParamManager#createProvider(Class)} - * - * @param cacheManager handles the parameter caching - */ - SSMProvider(CacheManager cacheManager) { - this(cacheManager, Builder.createClient()); - } - /** * Create a builder that can be used to configure and create a {@link SSMProvider}. * @@ -242,7 +233,7 @@ SsmClient getClient() { return client; } - static class Builder { + public static class Builder { private SsmClient client; private CacheManager cacheManager; private TransformationManager transformationManager; @@ -253,7 +244,7 @@ private static SsmClient createClient() { .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) .overrideConfiguration(ClientOverrideConfiguration.builder() .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(PARAMETERS)).build()) + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) .build(); } @@ -264,7 +255,8 @@ private static SsmClient createClient() { */ public SSMProvider build() { if (cacheManager == null) { - throw new IllegalStateException("No CacheManager provided, please provide one"); + // TODO - do we want to share this somehow? + cacheManager = new CacheManager(); } SSMProvider provider; if (client == null) { diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java similarity index 74% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/SSMProviderTest.java rename to powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index 2a4f8f927..a85f71727 100644 --- a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.ssm; import static java.util.Arrays.asList; import static org.assertj.core.api.Assertions.assertThat; @@ -27,12 +27,16 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; +import org.assertj.core.api.Assertions; import org.assertj.core.data.MapEntry; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; +import org.mockito.ArgumentMatchers; import org.mockito.Captor; import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.awssdk.services.ssm.model.GetParameterRequest; import software.amazon.awssdk.services.ssm.model.GetParameterResponse; @@ -62,7 +66,7 @@ public class SSMProviderTest { @BeforeEach public void init() { - openMocks(this); + MockitoAnnotations.openMocks(this); cacheManager = new CacheManager(); provider = new SSMProvider(cacheManager, client); } @@ -75,9 +79,9 @@ public void getValue() { String value = provider.getValue(key); - assertThat(value).isEqualTo(expectedValue); - assertThat(paramCaptor.getValue().name()).isEqualTo(key); - assertThat(paramCaptor.getValue().withDecryption()).isFalse(); + Assertions.assertThat(value).isEqualTo(expectedValue); + Assertions.assertThat(paramCaptor.getValue().name()).isEqualTo(key); + Assertions.assertThat(paramCaptor.getValue().withDecryption()).isFalse(); } @Test @@ -88,9 +92,9 @@ public void getValueDecrypted() { String value = provider.withDecryption().getValue(key); - assertThat(value).isEqualTo(expectedValue); - assertThat(paramCaptor.getValue().name()).isEqualTo(key); - assertThat(paramCaptor.getValue().withDecryption()).isTrue(); + Assertions.assertThat(value).isEqualTo(expectedValue); + Assertions.assertThat(paramCaptor.getValue().name()).isEqualTo(key); + Assertions.assertThat(paramCaptor.getValue().withDecryption()).isTrue(); } @Test @@ -100,10 +104,10 @@ public void getMultiple() { parameters.add(Parameter.builder().name("/prod/app1/key2").value("foo2").build()); parameters.add(Parameter.builder().name("/prod/app1/key3").value("foo3").build()); GetParametersByPathResponse response = GetParametersByPathResponse.builder().parameters(parameters).build(); - when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); + Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); Map params = provider.getMultiple("/prod/app1"); - assertThat(params).contains( + Assertions.assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -111,9 +115,9 @@ public void getMultiple() { assertThat(provider.get("/prod/app1/key2")).isEqualTo("foo2"); assertThat(provider.get("/prod/app1/key3")).isEqualTo("foo3"); - assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); - assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); - assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); + Assertions.assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); + Assertions.assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); + Assertions.assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); } @Test @@ -123,10 +127,10 @@ public void getMultipleWithTrailingSlash() { parameters.add(Parameter.builder().name("/prod/app1/key2").value("foo2").build()); parameters.add(Parameter.builder().name("/prod/app1/key3").value("foo3").build()); GetParametersByPathResponse response = GetParametersByPathResponse.builder().parameters(parameters).build(); - when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); + Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); Map params = provider.getMultiple("/prod/app1/"); - assertThat(params).contains( + Assertions.assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -134,9 +138,9 @@ public void getMultipleWithTrailingSlash() { assertThat(provider.get("/prod/app1/key2")).isEqualTo("foo2"); assertThat(provider.get("/prod/app1/key3")).isEqualTo("foo3"); - assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); - assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); - assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); + Assertions.assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); + Assertions.assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); + Assertions.assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); } @Test @@ -146,7 +150,7 @@ public void getMultiple_cached_shouldNotCallSSM() { parameters.add(Parameter.builder().name("/prod/app1/key2").value("foo2").build()); parameters.add(Parameter.builder().name("/prod/app1/key3").value("foo3").build()); GetParametersByPathResponse response = GetParametersByPathResponse.builder().parameters(parameters).build(); - when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); + Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); provider.getMultiple("/prod/app1"); @@ -156,7 +160,7 @@ public void getMultiple_cached_shouldNotCallSSM() { provider.get("/prod/app1/key2"); provider.get("/prod/app1/key3"); - verify(client, times(1)).getParametersByPath(any(GetParametersByPathRequest.class)); + Mockito.verify(client, Mockito.times(1)).getParametersByPath(ArgumentMatchers.any(GetParametersByPathRequest.class)); } @@ -172,11 +176,11 @@ public void getMultipleWithNextToken() { parameters2.add(Parameter.builder().name("/prod/app1/key3").value("foo3").build()); GetParametersByPathResponse response2 = GetParametersByPathResponse.builder().parameters(parameters2).build(); - when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response1, response2); + Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response1, response2); Map params = provider.getMultiple("/prod/app1"); - assertThat(params).contains( + Assertions.assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -185,22 +189,22 @@ public void getMultipleWithNextToken() { GetParametersByPathRequest request1 = requestParams.get(0); GetParametersByPathRequest request2 = requestParams.get(1); - assertThat(asList(request1, request2)).allSatisfy(req -> + Assertions.assertThat(asList(request1, request2)).allSatisfy(req -> { - assertThat(req.path()).isEqualTo("/prod/app1"); - assertThat(req.withDecryption()).isFalse(); - assertThat(req.recursive()).isFalse(); + Assertions.assertThat(req.path()).isEqualTo("/prod/app1"); + Assertions.assertThat(req.withDecryption()).isFalse(); + Assertions.assertThat(req.recursive()).isFalse(); }); - assertThat(request1.nextToken()).isNull(); - assertThat(request2.nextToken()).isEqualTo("123abc"); + Assertions.assertThat(request1.nextToken()).isNull(); + Assertions.assertThat(request2.nextToken()).isEqualTo("123abc"); } @Test public void testSecretsProviderBuilderMissingCacheManager_throwsException() { // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> SSMProvider.builder() + Assertions.assertThatIllegalStateException().isThrownBy(() -> SSMProvider.builder() .withClient(client) .withTransformationManager(transformationManager) .build()) @@ -210,7 +214,7 @@ public void testSecretsProviderBuilderMissingCacheManager_throwsException() { private void initMock(String expectedValue) { Parameter parameter = Parameter.builder().value(expectedValue).build(); GetParameterResponse result = GetParameterResponse.builder().parameter(parameter).build(); - when(client.getParameter(paramCaptor.capture())).thenReturn(result); + Mockito.when(client.getParameter(paramCaptor.capture())).thenReturn(result); provider.defaultMaxAge(1, ChronoUnit.DAYS); provider.withMaxAge(2, ChronoUnit.DAYS); provider.recursive(); diff --git a/powertools-parameters/powertools-parameters-tests/pom.xml b/powertools-parameters/powertools-parameters-tests/pom.xml new file mode 100644 index 000000000..cff5a6324 --- /dev/null +++ b/powertools-parameters/powertools-parameters-tests/pom.xml @@ -0,0 +1,64 @@ + + + 4.0.0 + + software.amazon.lambda + powertools-parent + 2.0.0-SNAPSHOT + ../../pom.xml + + + powertools-parameters-tests + Powertools parameters tests that cut across all the parameters providers + + + true + + + + + software.amazon.lambda + powertools-parameters-ssm + ${project.version} + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-core + test + + + org.mockito + mockito-inline + test + + + org.apache.commons + commons-lang3 + test + + + org.assertj + assertj-core + test + + + org.aspectj + aspectjweaver + test + + + \ No newline at end of file diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspectTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java similarity index 74% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspectTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java index 2c246336b..0e978d274 100644 --- a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspectTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java @@ -1,4 +1,4 @@ -/* +package software.amazon.lambda.powertools.parameters;/* * Copyright 2023 Amazon.com, Inc. or its affiliates. * Licensed under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance @@ -12,8 +12,6 @@ * */ -package software.amazon.lambda.powertools.parameters.internal; - import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.mockito.Mockito.mockStatic; @@ -22,14 +20,19 @@ import static org.mockito.Mockito.when; import static org.mockito.MockitoAnnotations.openMocks; +import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockedStatic; +import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; import software.amazon.lambda.powertools.parameters.Param; import software.amazon.lambda.powertools.parameters.ParamManager; -import software.amazon.lambda.powertools.parameters.SSMProvider; import software.amazon.lambda.powertools.parameters.exception.TransformationException; +import software.amazon.lambda.powertools.parameters.internal.AnotherObject; +import software.amazon.lambda.powertools.parameters.internal.CustomProvider; +import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; import software.amazon.lambda.powertools.parameters.transform.Base64Transformer; import software.amazon.lambda.powertools.parameters.transform.JsonTransformer; import software.amazon.lambda.powertools.parameters.transform.ObjectToDeserialize; @@ -39,7 +42,7 @@ public class LambdaParametersAspectTest { @Mock private SSMProvider defaultProvider; - @Param(key = "/default") + @Param(key = "/default", provider = SSMProvider.class) private String defaultValue; @Param(key = "/simple", provider = CustomProvider.class) @@ -56,18 +59,18 @@ public class LambdaParametersAspectTest { @BeforeEach public void init() { - openMocks(this); + MockitoAnnotations.openMocks(this); } @Test public void testDefault_ShouldUseSSMProvider() { - try (MockedStatic mocked = mockStatic(ParamManager.class)) { + try (MockedStatic mocked = Mockito.mockStatic(ParamManager.class)) { mocked.when(() -> ParamManager.getProvider(SSMProvider.class)).thenReturn(defaultProvider); - when(defaultProvider.get("/default")).thenReturn("value"); + Mockito.when(defaultProvider.get("/default")).thenReturn("value"); - assertThat(defaultValue).isEqualTo("value"); - mocked.verify(() -> ParamManager.getProvider(SSMProvider.class), times(1)); - verify(defaultProvider, times(1)).get("/default"); + Assertions.assertThat(defaultValue).isEqualTo("value"); + mocked.verify(() -> ParamManager.getProvider(SSMProvider.class), Mockito.times(1)); + Mockito.verify(defaultProvider, Mockito.times(1)).get("/default"); mocked.reset(); } @@ -75,17 +78,17 @@ public void testDefault_ShouldUseSSMProvider() { @Test public void testSimple() { - assertThat(param).isEqualTo("value"); + Assertions.assertThat(param).isEqualTo("value"); } @Test public void testWithBasicTransform() { - assertThat(basicTransform).isEqualTo("value"); + Assertions.assertThat(basicTransform).isEqualTo("value"); } @Test public void testWithComplexTransform() { - assertThat(complexTransform) + Assertions.assertThat(complexTransform) .isInstanceOf(ObjectToDeserialize.class) .matches( o -> o.getFoo().equals("Foo") && @@ -95,7 +98,7 @@ public void testWithComplexTransform() { @Test public void testWithComplexTransformWrongTargetClass_ShouldThrowException() { - assertThatExceptionOfType(TransformationException.class) + Assertions.assertThatExceptionOfType(TransformationException.class) .isThrownBy(() -> { AnotherObject obj = wrongTransform; diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java similarity index 93% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index d6fbe66f0..67ea03618 100644 --- a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -43,6 +43,8 @@ import software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest; import software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse; import software.amazon.awssdk.services.ssm.model.Parameter; +import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; public class ParamManagerIntegrationTest { @@ -71,7 +73,9 @@ public void setup() throws IllegalAccessException { @Test public void ssmProvider_get() { - SSMProvider ssmProvider = ParamManager.getSsmProvider(ssmClient); + SSMProvider ssmProvider = SSMProvider.builder() + .withClient(ssmClient) + .build(); String expectedValue = "value"; Parameter parameter = Parameter.builder().value(expectedValue).build(); @@ -87,7 +91,9 @@ public void ssmProvider_get() { @Test public void ssmProvider_getMultiple() { - SSMProvider ssmProvider = ParamManager.getSsmProvider(ssmClient); + SSMProvider ssmProvider = SSMProvider.builder() + .withClient(ssmClient) + .build(); List parameters = new ArrayList<>(); parameters.add(Parameter.builder().name("/prod/app1/key1").value("foo1").build()); diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java similarity index 92% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java index b84fcf743..dbfcb1007 100644 --- a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java @@ -91,16 +91,6 @@ public void testGetSecretsProvider_withoutParameter_shouldCreateDefaultClient() assertNotNull(secretsProvider.getClient()); } - @Test - public void testGetSSMProvider_withoutParameter_shouldCreateDefaultClient() { - - // Act - SSMProvider ssmProvider = ParamManager.getSsmProvider(); - - // Assert - assertNotNull(ssmProvider); - assertNotNull(ssmProvider.getClient()); - } @Test public void testGetDynamoDBProvider_requireOtherParameters_throwException() { diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/cache/CacheManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/cache/CacheManagerTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/cache/CacheManagerTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/cache/CacheManagerTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/cache/DataStoreTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/cache/DataStoreTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/cache/DataStoreTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/cache/DataStoreTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/AnotherObject.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/AnotherObject.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/AnotherObject.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/AnotherObject.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/Base64TransformerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/Base64TransformerTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/Base64TransformerTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/Base64TransformerTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/JsonTransformerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/JsonTransformerTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/JsonTransformerTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/JsonTransformerTest.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/ObjectToDeserialize.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/ObjectToDeserialize.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/ObjectToDeserialize.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/ObjectToDeserialize.java diff --git a/powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/TransformationManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/TransformationManagerTest.java similarity index 100% rename from powertools-parameters/src/test/java/software/amazon/lambda/powertools/parameters/transform/TransformationManagerTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/transform/TransformationManagerTest.java diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java index 7ffb0310c..d456cbd99 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java @@ -39,7 +39,7 @@ public @interface Param { String key(); - Class provider() default SSMProvider.class; + Class provider(); Class transformer() default Transformer.class; } diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java index 6fee0f114..33f93779c 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java @@ -19,7 +19,6 @@ import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; -import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -37,7 +36,6 @@ public final class ParamManager { /** * Get a concrete implementation of {@link BaseProvider}.
- * You can specify {@link SecretsProvider}, {@link SSMProvider} or create your * custom provider by extending {@link BaseProvider} if you need to integrate with a different parameter store. * * @return a {@link SecretsProvider} @@ -65,15 +63,6 @@ public static SecretsProvider getSecretsProvider() { return getProvider(SecretsProvider.class); } - /** - * Get a {@link SSMProvider} with default {@link SsmClient}.
- * If you need to customize the region, or other part of the client, use {@link ParamManager#getSsmProvider(SsmClient)} instead. - * - * @return a {@link SSMProvider} - */ - public static SSMProvider getSsmProvider() { - return getProvider(SSMProvider.class); - } /** * Get a {@link DynamoDbProvider} with default {@link DynamoDbClient}
@@ -111,7 +100,7 @@ public static AppConfigProvider getAppConfigProvider(String environment, String /** * Get a {@link SecretsProvider} with your custom {@link SecretsManagerClient}.
- * Use this to configure region or other part of the client. Use {@link ParamManager#getSsmProvider()} if you don't need this customization. + * Use this to configure region or other part of the client. Use {@link ParamManager#getSecretsProvider()} if you don't need this customization. * * @return a {@link SecretsProvider} */ @@ -123,20 +112,6 @@ public static SecretsProvider getSecretsProvider(SecretsManagerClient client) { .build()); } - /** - * Get a {@link SSMProvider} with your custom {@link SsmClient}.
- * Use this to configure region or other part of the client. Use {@link ParamManager#getSsmProvider()} if you don't need this customization. - * - * @return a {@link SSMProvider} - */ - public static SSMProvider getSsmProvider(SsmClient client) { - return (SSMProvider) providers.computeIfAbsent(SSMProvider.class, (k) -> SSMProvider.builder() - .withClient(client) - .withCacheManager(cacheManager) - .withTransformationManager(transformationManager) - .build()); - } - /** * Get a {@link DynamoDbProvider} with your custom {@link DynamoDbClient}.
* Use this to configure region or other part of the client. Use {@link ParamManager#getDynamoDbProvider(String)} )} if you don't need this customization. From a357255707dad469fd14d092ec2a88ad2a68e7bb Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 29 Aug 2023 14:12:58 +0200 Subject: [PATCH 02/45] Move secrets out --- .../powertools-examples-parameters/pom.xml | 6 + .../demo/parameters/ParametersFunction.java | 6 +- pom.xml | 1 + powertools-parameters/pom.xml | 14 --- .../powertools-parameters-secrets/pom.xml | 117 ++++++++++++++++++ .../parameters/secrets}/SecretsProvider.java | 10 +- .../secrets}/SecretsProviderTest.java | 32 ++--- .../powertools-parameters-ssm/pom.xml | 29 ++--- .../powertools-parameters-tests/pom.xml | 5 + .../LambdaParametersAspectTest.java | 25 ++-- .../ParamManagerIntegrationTest.java | 6 +- .../parameters/ParamManagerTest.java | 12 +- .../powertools/parameters/ParamManager.java | 25 ---- 13 files changed, 190 insertions(+), 98 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-secrets/pom.xml rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets}/SecretsProvider.java (96%) rename powertools-parameters/{powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters => powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets}/SecretsProviderTest.java (77%) diff --git a/examples/powertools-examples-parameters/pom.xml b/examples/powertools-examples-parameters/pom.xml index 03b9e4dad..27ac69373 100644 --- a/examples/powertools-examples-parameters/pom.xml +++ b/examples/powertools-examples-parameters/pom.xml @@ -24,6 +24,12 @@ powertools-parameters-ssm ${project.version} + + software.amazon.lambda + powertools-parameters-secrets + ${project.version} + + com.amazonaws aws-lambda-java-core diff --git a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java index 5dfec8031..6eb52a165 100644 --- a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java +++ b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java @@ -32,8 +32,8 @@ import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import software.amazon.lambda.powertools.parameters.ParamManager; +import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; -import software.amazon.lambda.powertools.parameters.SecretsProvider; public class ParametersFunction implements RequestHandler { private final static Logger log = LogManager.getLogger(ParametersFunction.class); @@ -41,7 +41,9 @@ public class ParametersFunction implements RequestHandlerexamples powertools-parameters/powertools-parameters-ssm powertools-parameters/powertools-parameters-tests + powertools-parameters/powertools-parameters-secrets diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml index 95ec9cd6b..7accdce6b 100644 --- a/powertools-parameters/pom.xml +++ b/powertools-parameters/pom.xml @@ -58,20 +58,6 @@ software.amazon.lambda powertools-common - - software.amazon.awssdk - secretsmanager - - - software.amazon.awssdk - apache-client - - - software.amazon.awssdk - netty-nio-client - - - software.amazon.awssdk url-connection-client diff --git a/powertools-parameters/powertools-parameters-secrets/pom.xml b/powertools-parameters/powertools-parameters-secrets/pom.xml new file mode 100644 index 000000000..5b4dfad34 --- /dev/null +++ b/powertools-parameters/powertools-parameters-secrets/pom.xml @@ -0,0 +1,117 @@ + + + 4.0.0 + + + software.amazon.lambda + powertools-parent + 2.0.0-SNAPSHOT + ../../pom.xml + + + powertools-parameters-secrets + Powertools for AWS Lambda (Java) library Parameters - Secrets Manager + Secrets Manager implementation for the Parameters module + + + GitHub Issues + https://github.com/aws-powertools/powertools-lambda-java/issues + + + https://github.com/aws-powertools/powertools-lambda-java.git + + + + Powertools for AWS Lambda team + Amazon Web Services + https://aws.amazon.com/ + + + + + + ossrh + https://aws.oss.sonatype.org/content/repositories/snapshots + + + + + + software.amazon.lambda + powertools-parameters + ${project.version} + + + + software.amazon.awssdk + secretsmanager + + + software.amazon.awssdk + apache-client + + + software.amazon.awssdk + netty-nio-client + + + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-core + test + + + org.mockito + mockito-inline + test + + + org.apache.commons + commons-lang3 + test + + + org.assertj + assertj-core + test + + + org.aspectj + aspectjweaver + test + + + + + + + maven-surefire-plugin + 3.1.2 + + + eu-central-1 + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + \ No newline at end of file diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java similarity index 96% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SecretsProvider.java rename to powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index b77f501f2..0cdb05a62 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.secrets; import static java.nio.charset.StandardCharsets.UTF_8; @@ -27,6 +27,7 @@ import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.awssdk.services.secretsmanager.model.GetSecretValueRequest; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; import software.amazon.lambda.powertools.parameters.transform.Transformer; @@ -151,7 +152,7 @@ SecretsManagerClient getClient() { return client; } - static class Builder { + public static class Builder { private SecretsManagerClient client; private CacheManager cacheManager; @@ -163,7 +164,7 @@ private static SecretsManagerClient createClient() { .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) .overrideConfiguration(ClientOverrideConfiguration.builder() .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(PARAMETERS)).build()) + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) .build(); } @@ -174,7 +175,8 @@ private static SecretsManagerClient createClient() { */ public SecretsProvider build() { if (cacheManager == null) { - throw new IllegalStateException("No CacheManager provided, please provide one"); + // TODO - what should we do with this + cacheManager = new CacheManager(); } SecretsProvider provider; if (client == null) { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java similarity index 77% rename from powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java rename to powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java index f4f2d9bee..1b4cc4306 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/SecretsProviderTest.java +++ b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java @@ -12,21 +12,24 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.secrets; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalStateException; import static org.assertj.core.api.Assertions.assertThatRuntimeException; +import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.mockito.MockitoAnnotations.openMocks; import java.time.temporal.ChronoUnit; import java.util.Base64; +import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Captor; import org.mockito.Mock; import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; import software.amazon.awssdk.core.SdkBytes; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.awssdk.services.secretsmanager.model.GetSecretValueRequest; @@ -51,7 +54,7 @@ public class SecretsProviderTest { @BeforeEach public void init() { - openMocks(this); + MockitoAnnotations.openMocks(this); cacheManager = new CacheManager(); provider = new SecretsProvider(cacheManager, client); } @@ -67,8 +70,8 @@ public void getValue() { String value = provider.getValue(key); - assertThat(value).isEqualTo(expectedValue); - assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); + Assertions.assertThat(value).isEqualTo(expectedValue); + Assertions.assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); } @Test @@ -82,27 +85,28 @@ public void getValueBase64() { String value = provider.getValue(key); - assertThat(value).isEqualTo(expectedValue); - assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); + Assertions.assertThat(value).isEqualTo(expectedValue); + Assertions.assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); } @Test public void getMultipleValuesThrowsException() { // Act & Assert - assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) + Assertions.assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) .withMessage("Impossible to get multiple values from AWS Secrets Manager"); } @Test - public void testSecretsProviderBuilderMissingCacheManager_throwsException() { + public void testGetSecretsProvider_withoutParameter_shouldCreateDefaultClient() { - // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> SecretsProvider.builder() - .withClient(client) - .withTransformationManager(transformationManager) - .build()) - .withMessage("No CacheManager provided, please provide one"); + // Act + SecretsProvider secretsProvider = SecretsProvider.builder() + .build(); + + // Assert + assertNotNull(secretsProvider); + assertNotNull(secretsProvider.getClient()); } } diff --git a/powertools-parameters/powertools-parameters-ssm/pom.xml b/powertools-parameters/powertools-parameters-ssm/pom.xml index fae952999..47acd5906 100644 --- a/powertools-parameters/powertools-parameters-ssm/pom.xml +++ b/powertools-parameters/powertools-parameters-ssm/pom.xml @@ -44,6 +44,21 @@ ${project.version} + + software.amazon.awssdk + ssm + + + software.amazon.awssdk + apache-client + + + software.amazon.awssdk + netty-nio-client + + + + org.junit.jupiter @@ -80,20 +95,6 @@ aspectjweaver test - - software.amazon.awssdk - ssm - - - software.amazon.awssdk - apache-client - - - software.amazon.awssdk - netty-nio-client - - - diff --git a/powertools-parameters/powertools-parameters-tests/pom.xml b/powertools-parameters/powertools-parameters-tests/pom.xml index cff5a6324..b527b9e46 100644 --- a/powertools-parameters/powertools-parameters-tests/pom.xml +++ b/powertools-parameters/powertools-parameters-tests/pom.xml @@ -23,6 +23,11 @@ powertools-parameters-ssm ${project.version} + + software.amazon.lambda + powertools-parameters-secrets + ${project.version} + diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java index 0e978d274..c99608d57 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java @@ -63,18 +63,19 @@ public void init() { } @Test - public void testDefault_ShouldUseSSMProvider() { - try (MockedStatic mocked = Mockito.mockStatic(ParamManager.class)) { - mocked.when(() -> ParamManager.getProvider(SSMProvider.class)).thenReturn(defaultProvider); - Mockito.when(defaultProvider.get("/default")).thenReturn("value"); - - Assertions.assertThat(defaultValue).isEqualTo("value"); - mocked.verify(() -> ParamManager.getProvider(SSMProvider.class), Mockito.times(1)); - Mockito.verify(defaultProvider, Mockito.times(1)).get("/default"); - - mocked.reset(); - } - } + // TODO - no more defaults! +// public void testDefault_ShouldUseSSMProvider() { +// try (MockedStatic mocked = Mockito.mockStatic(ParamManager.class)) { +// mocked.when(() -> ParamManager.getProvider(SSMProvider.class)).thenReturn(defaultProvider); +// Mockito.when(defaultProvider.get("/default")).thenReturn("value"); +// +// Assertions.assertThat(defaultValue).isEqualTo("value"); +// mocked.verify(() -> ParamManager.getProvider(SSMProvider.class), Mockito.times(1)); +// Mockito.verify(defaultProvider, Mockito.times(1)).get("/default"); +// +// mocked.reset(); +// } +// } @Test public void testSimple() { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index 67ea03618..807aae1ef 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -43,7 +43,7 @@ import software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest; import software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse; import software.amazon.awssdk.services.ssm.model.Parameter; -import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; public class ParamManagerIntegrationTest { @@ -118,7 +118,9 @@ public void ssmProvider_getMultiple() { @Test public void secretsProvider_get() { - SecretsProvider secretsProvider = ParamManager.getSecretsProvider(secretsManagerClient); + SecretsProvider secretsProvider = SecretsProvider.builder() + .withClient(secretsManagerClient) + .build(); String expectedValue = "Value1"; GetSecretValueResponse response = GetSecretValueResponse.builder().secretString(expectedValue).build(); diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java index dbfcb1007..e4c7daabb 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java @@ -22,6 +22,7 @@ import org.junit.jupiter.api.Test; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.internal.CustomProvider; +import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; public class ParamManagerTest { @@ -80,17 +81,6 @@ public void testGetProviderWithProviderClass_throwsException() { assertThatIllegalStateException().isThrownBy(() -> ParamManager.getProvider(null)); } - @Test - public void testGetSecretsProvider_withoutParameter_shouldCreateDefaultClient() { - - // Act - SecretsProvider secretsProvider = ParamManager.getSecretsProvider(); - - // Assert - assertNotNull(secretsProvider); - assertNotNull(secretsProvider.getClient()); - } - @Test public void testGetDynamoDBProvider_requireOtherParameters_throwException() { diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java index 33f93779c..d3aaefaa5 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java @@ -53,17 +53,6 @@ public static T getProvider(Class providerClass) { return (T) providers.computeIfAbsent(providerClass, ParamManager::createProvider); } - /** - * Get a {@link SecretsProvider} with default {@link SecretsManagerClient}.
- * If you need to customize the region, or other part of the client, use {@link ParamManager#getSecretsProvider(SecretsManagerClient)} instead. - * - * @return a {@link SecretsProvider} - */ - public static SecretsProvider getSecretsProvider() { - return getProvider(SecretsProvider.class); - } - - /** * Get a {@link DynamoDbProvider} with default {@link DynamoDbClient}
* If you need to customize the region, or other part of the client, use {@link ParamManager#getDynamoDbProvider(DynamoDbClient, String)} @@ -98,20 +87,6 @@ public static AppConfigProvider getAppConfigProvider(String environment, String } - /** - * Get a {@link SecretsProvider} with your custom {@link SecretsManagerClient}.
- * Use this to configure region or other part of the client. Use {@link ParamManager#getSecretsProvider()} if you don't need this customization. - * - * @return a {@link SecretsProvider} - */ - public static SecretsProvider getSecretsProvider(SecretsManagerClient client) { - return (SecretsProvider) providers.computeIfAbsent(SecretsProvider.class, (k) -> SecretsProvider.builder() - .withClient(client) - .withCacheManager(cacheManager) - .withTransformationManager(transformationManager) - .build()); - } - /** * Get a {@link DynamoDbProvider} with your custom {@link DynamoDbClient}.
* Use this to configure region or other part of the client. Use {@link ParamManager#getDynamoDbProvider(String)} )} if you don't need this customization. From 7dd85d234ab519c7e232252d92a7e804449eb40d Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 29 Aug 2023 14:32:51 +0200 Subject: [PATCH 03/45] Move DDB out --- pom.xml | 3 +- powertools-parameters/pom.xml | 4 - .../powertools-parameters-dynamodb/pom.xml | 117 ++++++++++++++++++ .../dynamodb}/DynamoDbProvider.java | 4 +- .../dynamodb}/DynamoDbProviderE2ETest.java | 2 +- .../dynamodb}/DynamoDbProviderTest.java | 2 +- .../powertools-parameters-tests/pom.xml | 5 + .../LambdaParametersAspectTest.java | 2 +- .../ParamManagerIntegrationTest.java | 10 -- .../parameters/ParamManagerTest.java | 1 + .../powertools/parameters/ParamManager.java | 35 +----- 11 files changed, 132 insertions(+), 53 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-dynamodb/pom.xml rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb}/DynamoDbProvider.java (97%) rename powertools-parameters/{powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters => powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb}/DynamoDbProviderE2ETest.java (98%) rename powertools-parameters/{powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters => powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb}/DynamoDbProviderTest.java (99%) diff --git a/pom.xml b/pom.xml index 19f7c93fd..f6ecf8814 100644 --- a/pom.xml +++ b/pom.xml @@ -55,8 +55,9 @@ powertools-batch examples powertools-parameters/powertools-parameters-ssm - powertools-parameters/powertools-parameters-tests powertools-parameters/powertools-parameters-secrets + powertools-parameters/powertools-parameters-dynamodb + powertools-parameters/powertools-parameters-tests diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml index 7accdce6b..684083798 100644 --- a/powertools-parameters/pom.xml +++ b/powertools-parameters/pom.xml @@ -62,10 +62,6 @@ software.amazon.awssdk url-connection-client - - software.amazon.awssdk - dynamodb - software.amazon.awssdk appconfigdata diff --git a/powertools-parameters/powertools-parameters-dynamodb/pom.xml b/powertools-parameters/powertools-parameters-dynamodb/pom.xml new file mode 100644 index 000000000..71126f6b5 --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/pom.xml @@ -0,0 +1,117 @@ + + + 4.0.0 + + + software.amazon.lambda + powertools-parent + 2.0.0-SNAPSHOT + ../../pom.xml + + + powertools-parameters-dynamodb + Powertools for AWS Lambda (Java) library Parameters - DynamoDB + DynamoDB implementation for the Parameters module + + + GitHub Issues + https://github.com/aws-powertools/powertools-lambda-java/issues + + + https://github.com/aws-powertools/powertools-lambda-java.git + + + + Powertools for AWS Lambda team + Amazon Web Services + https://aws.amazon.com/ + + + + + + ossrh + https://aws.oss.sonatype.org/content/repositories/snapshots + + + + + + software.amazon.lambda + powertools-parameters + ${project.version} + + + + software.amazon.awssdk + dynamodb + + + software.amazon.awssdk + apache-client + + + software.amazon.awssdk + netty-nio-client + + + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-core + test + + + org.mockito + mockito-inline + test + + + org.apache.commons + commons-lang3 + test + + + org.assertj + assertj-core + test + + + org.aspectj + aspectjweaver + test + + + + + + + maven-surefire-plugin + 3.1.2 + + + eu-central-1 + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + \ No newline at end of file diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java similarity index 97% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/DynamoDbProvider.java rename to powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index 363f39d7c..27daf780e 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.dynamodb; import java.util.Collections; import java.util.Map; @@ -29,6 +29,8 @@ import software.amazon.awssdk.services.dynamodb.model.QueryRequest; import software.amazon.awssdk.services.dynamodb.model.QueryResponse; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.exception.DynamoDbProviderSchemaException; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java similarity index 98% rename from powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java rename to powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java index 18212b45c..c7530e1b7 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderE2ETest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.dynamodb; import static org.assertj.core.api.Assertions.assertThat; diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java similarity index 99% rename from powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java rename to powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java index 2cf84dad4..7e5b5f631 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/DynamoDbProviderTest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.dynamodb; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalStateException; diff --git a/powertools-parameters/powertools-parameters-tests/pom.xml b/powertools-parameters/powertools-parameters-tests/pom.xml index b527b9e46..b0bbfdf74 100644 --- a/powertools-parameters/powertools-parameters-tests/pom.xml +++ b/powertools-parameters/powertools-parameters-tests/pom.xml @@ -28,6 +28,11 @@ powertools-parameters-secrets ${project.version} + + software.amazon.lambda + powertools-parameters-dynamodb + ${project.version} + diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java index c99608d57..db4c17b50 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java @@ -62,7 +62,7 @@ public void init() { MockitoAnnotations.openMocks(this); } - @Test + // @Test // TODO - no more defaults! // public void testDefault_ShouldUseSSMProvider() { // try (MockedStatic mocked = Mockito.mockStatic(ParamManager.class)) { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index 807aae1ef..ff125666e 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -133,16 +133,6 @@ public void secretsProvider_get() { verify(secretsManagerClient, times(1)).getSecretValue(any(GetSecretValueRequest.class)); } - @Test - public void getDynamoDbProvider() { - - // Act - DynamoDbProvider provider = ParamManager.getDynamoDbProvider(ddbClient, "test-table"); - - // Assert - assertThat(provider).isNotNull(); - } - @Test public void getAppConfigProvider() { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java index e4c7daabb..ad512e563 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java @@ -21,6 +21,7 @@ import org.junit.jupiter.api.Test; import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProvider; import software.amazon.lambda.powertools.parameters.internal.CustomProvider; import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java index d3aaefaa5..6c0a5e72e 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java @@ -17,8 +17,6 @@ import java.lang.reflect.Constructor; import java.util.concurrent.ConcurrentHashMap; import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; -import software.amazon.awssdk.services.dynamodb.DynamoDbClient; -import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -46,28 +44,13 @@ public static T getProvider(Class providerClass) { if (providerClass == null) { throw new IllegalStateException("providerClass cannot be null."); } - if (providerClass == DynamoDbProvider.class || providerClass == AppConfigProvider.class) { + if (providerClass == AppConfigProvider.class) { throw new IllegalArgumentException( providerClass + " cannot be instantiated like this, additional parameters are required"); } return (T) providers.computeIfAbsent(providerClass, ParamManager::createProvider); } - /** - * Get a {@link DynamoDbProvider} with default {@link DynamoDbClient}
- * If you need to customize the region, or other part of the client, use {@link ParamManager#getDynamoDbProvider(DynamoDbClient, String)} - */ - public static DynamoDbProvider getDynamoDbProvider(String tableName) { - // Because we need a DDB table name to configure our client, we can't use - // ParamManager#getProvider. This means that we need to make sure we do the same stuff - - // set transformation manager and cache manager. - return DynamoDbProvider.builder() - .withCacheManager(cacheManager) - .withTable(tableName) - .withTransformationManager(transformationManager) - .build(); - } - /** * Get a {@link AppConfigProvider} with default {@link AppConfigDataClient}.
* If you need to customize the region, or other part of the client, use {@link ParamManager#getAppConfigProvider(AppConfigDataClient, String, String)} instead. @@ -86,22 +69,6 @@ public static AppConfigProvider getAppConfigProvider(String environment, String .build(); } - - /** - * Get a {@link DynamoDbProvider} with your custom {@link DynamoDbClient}.
- * Use this to configure region or other part of the client. Use {@link ParamManager#getDynamoDbProvider(String)} )} if you don't need this customization. - * - * @return a {@link DynamoDbProvider} - */ - public static DynamoDbProvider getDynamoDbProvider(DynamoDbClient client, String table) { - return (DynamoDbProvider) providers.computeIfAbsent(DynamoDbProvider.class, (k) -> DynamoDbProvider.builder() - .withClient(client) - .withTable(table) - .withCacheManager(cacheManager) - .withTransformationManager(transformationManager) - .build()); - } - /** * Get a {@link AppConfigProvider} with your custom {@link AppConfigDataClient}.
* Use this to configure region or other part of the client. Use {@link ParamManager#getAppConfigProvider(String, String)} if you don't need this customization. From 058fb139ecab7d315eb4c10fbb69a9736938ed00 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 29 Aug 2023 14:47:35 +0200 Subject: [PATCH 04/45] Moved AppConfig out --- pom.xml | 1 + powertools-parameters/pom.xml | 4 - .../powertools-parameters-appconfig/pom.xml | 117 ++++++++++++++++++ .../appconfig}/AppConfigProvider.java | 5 +- .../appconfig}/AppConfigProviderTest.java | 51 ++++---- .../ParamManagerIntegrationTest.java | 10 -- .../parameters/ParamManagerTest.java | 6 - .../powertools/parameters/ParamManager.java | 40 ------ 8 files changed, 145 insertions(+), 89 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-appconfig/pom.xml rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig}/AppConfigProvider.java (98%) rename powertools-parameters/{powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters => powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig}/AppConfigProviderTest.java (78%) diff --git a/pom.xml b/pom.xml index f6ecf8814..47cc228db 100644 --- a/pom.xml +++ b/pom.xml @@ -58,6 +58,7 @@ powertools-parameters/powertools-parameters-secrets powertools-parameters/powertools-parameters-dynamodb powertools-parameters/powertools-parameters-tests + powertools-parameters/powertools-parameters-appconfig diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml index 684083798..433226f81 100644 --- a/powertools-parameters/pom.xml +++ b/powertools-parameters/pom.xml @@ -62,10 +62,6 @@ software.amazon.awssdk url-connection-client - - software.amazon.awssdk - appconfigdata - com.fasterxml.jackson.core diff --git a/powertools-parameters/powertools-parameters-appconfig/pom.xml b/powertools-parameters/powertools-parameters-appconfig/pom.xml new file mode 100644 index 000000000..46c0dcd01 --- /dev/null +++ b/powertools-parameters/powertools-parameters-appconfig/pom.xml @@ -0,0 +1,117 @@ + + + 4.0.0 + + + software.amazon.lambda + powertools-parent + 2.0.0-SNAPSHOT + ../../pom.xml + + + powertools-parameters-appconfig + Powertools for AWS Lambda (Java) library Parameters - AppConfig + AppConfig implementation for the Parameters module + + + GitHub Issues + https://github.com/aws-powertools/powertools-lambda-java/issues + + + https://github.com/aws-powertools/powertools-lambda-java.git + + + + Powertools for AWS Lambda team + Amazon Web Services + https://aws.amazon.com/ + + + + + + ossrh + https://aws.oss.sonatype.org/content/repositories/snapshots + + + + + + software.amazon.lambda + powertools-parameters + ${project.version} + + + + software.amazon.awssdk + appconfigdata + + + software.amazon.awssdk + apache-client + + + software.amazon.awssdk + netty-nio-client + + + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-core + test + + + org.mockito + mockito-inline + test + + + org.apache.commons + commons-lang3 + test + + + org.assertj + assertj-core + test + + + org.aspectj + aspectjweaver + test + + + + + + + maven-surefire-plugin + 3.1.2 + + + eu-central-1 + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + \ No newline at end of file diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java similarity index 98% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/AppConfigProvider.java rename to powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java index 5a1e575dd..cf35f27a9 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/AppConfigProvider.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters; +package software.amazon.lambda.powertools.parameters.appconfig; import java.util.HashMap; import java.util.Map; @@ -26,6 +26,7 @@ import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationResponse; import software.amazon.awssdk.services.appconfigdata.model.StartConfigurationSessionRequest; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -158,7 +159,7 @@ public AppConfigProvider build() { .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) .overrideConfiguration(ClientOverrideConfiguration.builder() .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(PARAMETERS)).build()) + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) .build(); } diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java similarity index 78% rename from powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java rename to powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java index f467dca72..780e3cb37 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/AppConfigProviderTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java @@ -12,19 +12,16 @@ * */ -package software.amazon.lambda.powertools.parameters; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatIllegalStateException; -import static org.assertj.core.api.Assertions.assertThatRuntimeException; -import static org.mockito.MockitoAnnotations.openMocks; +package software.amazon.lambda.powertools.parameters.appconfig; +import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Captor; import org.mockito.Mock; import org.mockito.Mockito; +import org.mockito.MockitoAnnotations; import software.amazon.awssdk.core.SdkBytes; import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationRequest; @@ -52,7 +49,7 @@ public class AppConfigProviderTest { @BeforeEach public void init() { - openMocks(this); + MockitoAnnotations.openMocks(this); provider = AppConfigProvider.builder() .withClient(client) @@ -101,18 +98,18 @@ public void getValueRetrievesValue() { String returnedValue3 = provider.getValue(defaultTestKey); // Assert - assertThat(returnedValue1).isEqualTo(firstResponse.configuration().asUtf8String()); - assertThat(returnedValue2).isEqualTo(secondResponse.configuration().asUtf8String()); - assertThat(returnedValue3).isEqualTo(secondResponse.configuration() + Assertions.assertThat(returnedValue1).isEqualTo(firstResponse.configuration().asUtf8String()); + Assertions.assertThat(returnedValue2).isEqualTo(secondResponse.configuration().asUtf8String()); + Assertions.assertThat(returnedValue3).isEqualTo(secondResponse.configuration() .asUtf8String()); // Third response is mocked to return null and should re-use previous value - assertThat(startSessionRequestCaptor.getValue().applicationIdentifier()).isEqualTo(applicationName); - assertThat(startSessionRequestCaptor.getValue().environmentIdentifier()).isEqualTo(environmentName); - assertThat(startSessionRequestCaptor.getValue().configurationProfileIdentifier()).isEqualTo(defaultTestKey); - assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( + Assertions.assertThat(startSessionRequestCaptor.getValue().applicationIdentifier()).isEqualTo(applicationName); + Assertions.assertThat(startSessionRequestCaptor.getValue().environmentIdentifier()).isEqualTo(environmentName); + Assertions.assertThat(startSessionRequestCaptor.getValue().configurationProfileIdentifier()).isEqualTo(defaultTestKey); + Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( firstSession.initialConfigurationToken()); - assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( + Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( firstResponse.nextPollConfigurationToken()); - assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(2).configurationToken()).isEqualTo( + Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(2).configurationToken()).isEqualTo( secondResponse.nextPollConfigurationToken()); } @@ -136,7 +133,7 @@ public void getValueNoValueExists() { // Assert - assertThat(returnedValue).isEqualTo(null); + Assertions.assertThat(returnedValue).isEqualTo(null); } /** @@ -172,15 +169,15 @@ public void multipleKeysRetrievalWorks() { String secondKeyValue = provider.getValue(param2Key); // Assert - assertThat(firstKeyValue).isEqualTo(param1Response.configuration().asUtf8String()); - assertThat(secondKeyValue).isEqualTo(param2Response.configuration().asUtf8String()); - assertThat(startSessionRequestCaptor.getAllValues().get(0).configurationProfileIdentifier()).isEqualTo( + Assertions.assertThat(firstKeyValue).isEqualTo(param1Response.configuration().asUtf8String()); + Assertions.assertThat(secondKeyValue).isEqualTo(param2Response.configuration().asUtf8String()); + Assertions.assertThat(startSessionRequestCaptor.getAllValues().get(0).configurationProfileIdentifier()).isEqualTo( param1Key); - assertThat(startSessionRequestCaptor.getAllValues().get(1).configurationProfileIdentifier()).isEqualTo( + Assertions.assertThat(startSessionRequestCaptor.getAllValues().get(1).configurationProfileIdentifier()).isEqualTo( param2Key); - assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( + Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( param1Session.initialConfigurationToken()); - assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( + Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( param2Session.initialConfigurationToken()); } @@ -189,7 +186,7 @@ public void multipleKeysRetrievalWorks() { public void getMultipleValuesThrowsException() { // Act & Assert - assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) + Assertions.assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) .withMessage("Retrieving multiple parameter values is not supported with the AWS App Config Provider"); } @@ -197,7 +194,7 @@ public void getMultipleValuesThrowsException() { public void testAppConfigProviderBuilderMissingCacheManager_throwsException() { // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() + Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() .withEnvironment(environmentName) .withApplication(applicationName) .withClient(client) @@ -209,7 +206,7 @@ public void testAppConfigProviderBuilderMissingCacheManager_throwsException() { public void testAppConfigProviderBuilderMissingEnvironment_throwsException() { // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() + Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() .withCacheManager(new CacheManager()) .withApplication(applicationName) .withClient(client) @@ -221,7 +218,7 @@ public void testAppConfigProviderBuilderMissingEnvironment_throwsException() { public void testAppConfigProviderBuilderMissingApplication_throwsException() { // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() + Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() .withCacheManager(new CacheManager()) .withEnvironment(environmentName) .withClient(client) diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index ff125666e..032a11d0d 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -133,14 +133,4 @@ public void secretsProvider_get() { verify(secretsManagerClient, times(1)).getSecretValue(any(GetSecretValueRequest.class)); } - @Test - public void getAppConfigProvider() { - - // Act - AppConfigProvider provider = ParamManager.getAppConfigProvider(appConfigDataClient, "test-env", "test-app"); - - // Assert - assertThat(provider).isNotNull(); - - } } diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java index ad512e563..db64c31fd 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java @@ -90,10 +90,4 @@ public void testGetDynamoDBProvider_requireOtherParameters_throwException() { assertThatIllegalArgumentException().isThrownBy(() -> ParamManager.getProvider(DynamoDbProvider.class)); } - @Test - public void testGetAppConfigProvider_requireOtherParameters_throwException() { - - // Act & Assert - assertThatIllegalArgumentException().isThrownBy(() -> ParamManager.getProvider(AppConfigProvider.class)); - } } diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java index 6c0a5e72e..1a5f47ce2 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java @@ -16,7 +16,6 @@ import java.lang.reflect.Constructor; import java.util.concurrent.ConcurrentHashMap; -import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -44,48 +43,9 @@ public static T getProvider(Class providerClass) { if (providerClass == null) { throw new IllegalStateException("providerClass cannot be null."); } - if (providerClass == AppConfigProvider.class) { - throw new IllegalArgumentException( - providerClass + " cannot be instantiated like this, additional parameters are required"); - } return (T) providers.computeIfAbsent(providerClass, ParamManager::createProvider); } - /** - * Get a {@link AppConfigProvider} with default {@link AppConfigDataClient}.
- * If you need to customize the region, or other part of the client, use {@link ParamManager#getAppConfigProvider(AppConfigDataClient, String, String)} instead. - * - * @return a {@link AppConfigProvider} - */ - public static AppConfigProvider getAppConfigProvider(String environment, String application) { - // Because we need a DDB table name to configure our client, we can't use - // ParamManager#getProvider. This means that we need to make sure we do the same stuff - - // set transformation manager and cache manager. - return AppConfigProvider.builder() - .withCacheManager(cacheManager) - .withTransformationManager(transformationManager) - .withEnvironment(environment) - .withApplication(application) - .build(); - } - - /** - * Get a {@link AppConfigProvider} with your custom {@link AppConfigDataClient}.
- * Use this to configure region or other part of the client. Use {@link ParamManager#getAppConfigProvider(String, String)} if you don't need this customization. - * - * @return a {@link AppConfigProvider} - */ - public static AppConfigProvider getAppConfigProvider(AppConfigDataClient client, String environment, - String application) { - return (AppConfigProvider) providers.computeIfAbsent(AppConfigProvider.class, (k) -> AppConfigProvider.builder() - .withClient(client) - .withCacheManager(cacheManager) - .withTransformationManager(transformationManager) - .withEnvironment(environment) - .withApplication(application) - .build()); - } - public static CacheManager getCacheManager() { return cacheManager; From 2f79e7ca12bba5bb2c4b9b850165001fa8800687 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 30 Aug 2023 16:34:29 +0200 Subject: [PATCH 05/45] Gutting ParamManager --- .../parameters/appconfig/AppConfigParam.java | 22 +++++++ .../appconfig/AppConfigParametersAspect.java | 59 +++++++++++++++++++ .../parameters/secrets/SecretsProvider.java | 4 +- .../LambdaParametersAspectTest.java | 16 +---- .../ParamManagerIntegrationTest.java | 3 - .../LambdaParametersAspect.java | 2 +- .../powertools/parameters/ParamManager.java | 33 ----------- 7 files changed, 86 insertions(+), 53 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java create mode 100644 powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java rename powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/{internal => }/LambdaParametersAspect.java (97%) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java new file mode 100644 index 000000000..a13c85496 --- /dev/null +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java @@ -0,0 +1,22 @@ +package software.amazon.lambda.powertools.parameters.appconfig; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.transform.Transformer; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface AppConfigParam { + String key(); + + String environment(); + + String application(); + + Class provider(); + + Class transformer() default Transformer.class; +} diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java new file mode 100644 index 000000000..d9596e64f --- /dev/null +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -0,0 +1,59 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.appconfig; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Pointcut; +import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.Param; +import software.amazon.lambda.powertools.parameters.ParamManager; + +@Aspect +public class AppConfigParametersAspect { + + @Pointcut("get(* *) && @annotation(appConfigParamAnnotation)") + public void getParam(AppConfigParam appConfigParamAnnotation) { + } + + @Around("getParam(appConfigParamAnnotation)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final AppConfigParam appConfigParamAnnotation) { + AppConfigProvider provider = AppConfigProvider.builder() + .withEnvironment(appConfigParamAnnotation.environment()) + .withApplication(appConfigParamAnnotation.application()) + .build(); + + if (appConfigParamAnnotation.transformer().isInterface()) { + // No transformation + return provider.get(appConfigParamAnnotation.key()); + } else { + FieldSignature s = (FieldSignature) joinPoint.getSignature(); + if (String.class.isAssignableFrom(s.getFieldType())) { + // Basic transformation + return provider + .withTransformation(appConfigParamAnnotation.transformer()) + .get(appConfigParamAnnotation.key()); + } else { + // Complex transformation + return provider + .withTransformation(appConfigParamAnnotation.transformer()) + .get(appConfigParamAnnotation.key(), s.getFieldType()); + } + } + } + +} diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index 0cdb05a62..326c5ef36 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -68,7 +68,7 @@ public class SecretsProvider extends BaseProvider { * * @param client custom client you would like to use. */ - SecretsProvider(CacheManager cacheManager, SecretsManagerClient client) { + public SecretsProvider(CacheManager cacheManager, SecretsManagerClient client) { super(cacheManager); this.client = client; } @@ -80,7 +80,7 @@ public class SecretsProvider extends BaseProvider { * * @param cacheManager handles the parameter caching */ - SecretsProvider(CacheManager cacheManager) { + public SecretsProvider(CacheManager cacheManager) { this(cacheManager, Builder.createClient()); } diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java index db4c17b50..0fb945554 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java @@ -12,23 +12,11 @@ * */ -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.mockito.Mockito.mockStatic; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; -import static org.mockito.MockitoAnnotations.openMocks; - import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; -import org.mockito.MockedStatic; -import org.mockito.Mockito; import org.mockito.MockitoAnnotations; -import software.amazon.lambda.powertools.parameters.Param; -import software.amazon.lambda.powertools.parameters.ParamManager; import software.amazon.lambda.powertools.parameters.exception.TransformationException; import software.amazon.lambda.powertools.parameters.internal.AnotherObject; import software.amazon.lambda.powertools.parameters.internal.CustomProvider; @@ -42,8 +30,8 @@ public class LambdaParametersAspectTest { @Mock private SSMProvider defaultProvider; - @Param(key = "/default", provider = SSMProvider.class) - private String defaultValue; +// @Param(key = "/default", provider = SSMProvider.class) +// private String defaultValue; @Param(key = "/simple", provider = CustomProvider.class) private String param; diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index 032a11d0d..e06dd7e13 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -32,7 +32,6 @@ import org.mockito.ArgumentCaptor; import org.mockito.Captor; import org.mockito.Mock; -import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.awssdk.services.secretsmanager.model.GetSecretValueRequest; @@ -61,8 +60,6 @@ public class ParamManagerIntegrationTest { SecretsManagerClient secretsManagerClient; @Captor ArgumentCaptor secretsCaptor; - @Mock - private AppConfigDataClient appConfigDataClient; @BeforeEach public void setup() throws IllegalAccessException { diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java similarity index 97% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspect.java rename to powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java index 081af108d..4fad5ff8f 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/internal/LambdaParametersAspect.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters.internal; +package software.amazon.lambda.powertools.parameters; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java index 1a5f47ce2..79eb796e8 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java @@ -14,8 +14,6 @@ package software.amazon.lambda.powertools.parameters; -import java.lang.reflect.Constructor; -import java.util.concurrent.ConcurrentHashMap; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -28,25 +26,6 @@ public final class ParamManager { private static final CacheManager cacheManager = new CacheManager(); private static final TransformationManager transformationManager = new TransformationManager(); - // NOTE: For testing purposes `providers` cannot be final - private static ConcurrentHashMap, BaseProvider> providers = new ConcurrentHashMap<>(); - - /** - * Get a concrete implementation of {@link BaseProvider}.
- * custom provider by extending {@link BaseProvider} if you need to integrate with a different parameter store. - * - * @return a {@link SecretsProvider} - * @deprecated You should not use this method directly but a typed one (getSecretsProvider, getSsmProvider, getDynamoDbProvider, getAppConfigProvider), will be removed in v2 - */ - // TODO in v2: remove public access to this and review how we get providers (it was not designed for DDB and AppConfig in mind initially) - public static T getProvider(Class providerClass) { - if (providerClass == null) { - throw new IllegalStateException("providerClass cannot be null."); - } - return (T) providers.computeIfAbsent(providerClass, ParamManager::createProvider); - } - - public static CacheManager getCacheManager() { return cacheManager; } @@ -55,17 +34,5 @@ public static TransformationManager getTransformationManager() { return transformationManager; } - static T createProvider(Class providerClass) { - try { - Constructor constructor = providerClass.getDeclaredConstructor(CacheManager.class); - T provider = - constructor.newInstance(cacheManager); // FIXME: avoid reflection here as we may have issues (#1280) - provider.setTransformationManager(transformationManager); - return provider; - } catch (ReflectiveOperationException e) { - throw new RuntimeException("Unexpected error occurred. Please raise issue at " + - "https://github.com/aws-powertools/powertools-lambda-java/issues", e); - } - } } From 65501c3f64d06d07ad19d5ce3a51c785e176427e Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 13:13:09 +0200 Subject: [PATCH 06/45] Breaking up aspects --- .../gradle/README.md | 38 +++ .../gradle/build.gradle | 35 +++ .../gradle/events/event.json | 62 +++++ .../gradle/gradle/wrapper/.gitignore | 2 + .../gradle/gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 63375 bytes .../gradle/wrapper/gradle-wrapper.properties | 7 + .../gradle/gradlew | 248 ++++++++++++++++++ .../gradle/gradlew.bat | 92 +++++++ .../gradle/src/main/java/helloworld/App.java | 107 ++++++++ .../src/main/java/helloworld/AppStream.java | 38 +++ .../src/test/java/helloworld/AppTest.java | 24 ++ .../gradle/template.yaml | 71 +++++ .../.gradle/7.3.3/checksums/checksums.lock | Bin 0 -> 17 bytes .../.gradle/7.3.3/fileChanges/last-build.bin | Bin 0 -> 1 bytes .../.gradle/7.3.3/fileHashes/fileHashes.lock | Bin 0 -> 17 bytes .../gradle/.gradle/7.3.3/gc.properties | 0 .../gradle/.gradle/vcs-1/gc.properties | 0 .../parameters/appconfig/AppConfigParam.java | 2 - .../appconfig/AppConfigParametersAspect.java | 3 + .../appconfig/AppConfigProvider.java | 2 +- .../appconfig/AppConfigParamAspectTest.java | 20 ++ .../appconfig/AppConfigProviderTest.java | 12 - .../parameters/dynamodb/DynamoDbParam.java | 17 ++ .../dynamodb/DynamoDbParamAspect.java | 58 ++++ .../parameters/dynamodb/DynamoDbProvider.java | 2 +- .../parameters/secrets/SecretsParam.java | 15 ++ .../secrets/SecretsParamAspect.java | 57 ++++ .../powertools/parameters/ssm/SSMParam.java | 15 ++ .../parameters/ssm/SSMParamAspect.java | 57 ++++ .../parameters/ParamManagerTest.java | 80 +++--- .../parameters/LambdaParametersAspect.java | 44 ++-- 31 files changed, 1031 insertions(+), 77 deletions(-) create mode 100644 examples/powertools-examples-core-utilities/gradle/README.md create mode 100644 examples/powertools-examples-core-utilities/gradle/build.gradle create mode 100644 examples/powertools-examples-core-utilities/gradle/events/event.json create mode 100644 examples/powertools-examples-core-utilities/gradle/gradle/wrapper/.gitignore create mode 100644 examples/powertools-examples-core-utilities/gradle/gradle/wrapper/gradle-wrapper.jar create mode 100644 examples/powertools-examples-core-utilities/gradle/gradle/wrapper/gradle-wrapper.properties create mode 100755 examples/powertools-examples-core-utilities/gradle/gradlew create mode 100644 examples/powertools-examples-core-utilities/gradle/gradlew.bat create mode 100644 examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java create mode 100644 examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/AppStream.java create mode 100644 examples/powertools-examples-core-utilities/gradle/src/test/java/helloworld/AppTest.java create mode 100644 examples/powertools-examples-core-utilities/gradle/template.yaml create mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock create mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin create mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock create mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties create mode 100644 examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties create mode 100644 powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java create mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java create mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java create mode 100644 powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java create mode 100644 powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java create mode 100644 powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java create mode 100644 powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java diff --git a/examples/powertools-examples-core-utilities/gradle/README.md b/examples/powertools-examples-core-utilities/gradle/README.md new file mode 100644 index 000000000..cd6107151 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/README.md @@ -0,0 +1,38 @@ +# Powertools for AWS Lambda (Java) - Core Utilities Example with Gradle + +This project demonstrates the Lambda for Powertools Java module deployed using [Serverless Application Model](https://aws.amazon.com/serverless/sam/) with +[Gradle](https://gradle.org/) running the build. This example is configured for Java 1.8 only; in order to use a newer version, check out the Gradle +configuration guide [in the main project README](../../../README.md). + +You can also use `sam init` to create a new Gradle-powered Powertools application - choose to use the **AWS Quick Start Templates**, +and then **Hello World Example with Powertools for AWS Lambda**, **Java 17** runtime, and finally **gradle**. + + +For general information on the deployed example itself, you can refer to the parent [README](../../powertools-examples-core/README.md) + +## Configuration +SAM uses [template.yaml](template.yaml) to define the application's AWS resources. +This file defines the Lambda function to be deployed as well as API Gateway for it. + +The build of the project is managed by Gradle, and configured in [build.gradle](build.gradle). + +## Deploy the sample application +To get started, you can use the Gradle wrapper to bootstrap Gradle and run the build: + +```bash +./gradlew build +``` + +Once this is done to deploy the example, check out the instructions for getting started with SAM in +[the examples directory](../../README.md) + +## Additional notes + +You can watch the trace information or log information using the SAM CLI: +```bash +# Tail the logs +sam logs --tail $MY_STACK + +# Tail the traces +sam traces --tail +``` \ No newline at end of file diff --git a/examples/powertools-examples-core-utilities/gradle/build.gradle b/examples/powertools-examples-core-utilities/gradle/build.gradle new file mode 100644 index 000000000..e7367c246 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/build.gradle @@ -0,0 +1,35 @@ + +plugins { + id 'java' + id "io.freefair.aspectj.post-compile-weaving" version "6.6.3" +} + +wrapper { + gradleVersion = "7.6.1" +} + +compileJava { + sourceCompatibility = "1.8" + targetCompatibility = "1.8" + + ajc { + enabled = true + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'com.amazonaws:aws-lambda-java-core:1.2.2' + implementation 'com.fasterxml.jackson.core:jackson-annotations:2.13.2' + implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.2.2' + implementation 'com.amazonaws:aws-lambda-java-events:3.11.0' + implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.2' + aspect 'software.amazon.lambda:powertools-tracing:1.17.0' + aspect 'software.amazon.lambda:powertools-logging:1.17.0' + aspect 'software.amazon.lambda:powertools-metrics:1.17.0' + testImplementation 'junit:junit:4.13.2' +} + diff --git a/examples/powertools-examples-core-utilities/gradle/events/event.json b/examples/powertools-examples-core-utilities/gradle/events/event.json new file mode 100644 index 000000000..070ad8e01 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/events/event.json @@ -0,0 +1,62 @@ +{ + "body": "{\"message\": \"hello world\"}", + "resource": "/{proxy+}", + "path": "/path/to/resource", + "httpMethod": "POST", + "isBase64Encoded": false, + "queryStringParameters": { + "foo": "bar" + }, + "pathParameters": { + "proxy": "/path/to/resource" + }, + "stageVariables": { + "baz": "qux" + }, + "headers": { + "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8", + "Accept-Encoding": "gzip, deflate, sdch", + "Accept-Language": "en-US,en;q=0.8", + "Cache-Control": "max-age=0", + "CloudFront-Forwarded-Proto": "https", + "CloudFront-Is-Desktop-Viewer": "true", + "CloudFront-Is-Mobile-Viewer": "false", + "CloudFront-Is-SmartTV-Viewer": "false", + "CloudFront-Is-Tablet-Viewer": "false", + "CloudFront-Viewer-Country": "US", + "Host": "1234567890.execute-api.us-east-1.amazonaws.com", + "Upgrade-Insecure-Requests": "1", + "User-Agent": "Custom User Agent String", + "Via": "1.1 08f323deadbeefa7af34d5feb414ce27.cloudfront.net (CloudFront)", + "X-Amz-Cf-Id": "cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==", + "X-Forwarded-For": "127.0.0.1, 127.0.0.2", + "X-Forwarded-Port": "443", + "X-Forwarded-Proto": "https" + }, + "requestContext": { + "accountId": "123456789012", + "resourceId": "123456", + "stage": "prod", + "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef", + "requestTime": "09/Apr/2015:12:34:56 +0000", + "requestTimeEpoch": 1428582896000, + "identity": { + "cognitoIdentityPoolId": null, + "accountId": null, + "cognitoIdentityId": null, + "caller": null, + "accessKey": null, + "sourceIp": "127.0.0.1", + "cognitoAuthenticationType": null, + "cognitoAuthenticationProvider": null, + "userArn": null, + "userAgent": "Custom User Agent String", + "user": null + }, + "path": "/prod/path/to/resource", + "resourcePath": "/{proxy+}", + "httpMethod": "POST", + "apiId": "1234567890", + "protocol": "HTTP/1.1" + } +} diff --git a/examples/powertools-examples-core-utilities/gradle/gradle/wrapper/.gitignore b/examples/powertools-examples-core-utilities/gradle/gradle/wrapper/.gitignore new file mode 100644 index 000000000..59c09e205 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/gradle/wrapper/.gitignore @@ -0,0 +1,2 @@ +!gradle-wrapper.jar + diff --git a/examples/powertools-examples-core-utilities/gradle/gradle/wrapper/gradle-wrapper.jar b/examples/powertools-examples-core-utilities/gradle/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..033e24c4cdf41af1ab109bc7f253b2b887023340 GIT binary patch literal 63375 zcmb5VV{~QRw)Y#`wrv{~+qP{x72B%VwzFc}c2cp;N~)5ZbDrJayPv(!dGEd-##*zr z)#n-$y^sH|_dchh3@8{H5D*j;5D<{i*8l5IFJ|DjL!e)upfGNX(kojugZ3I`oH1PvW`wFW_ske0j@lB9bX zO;2)`y+|!@X(fZ1<2n!Qx*)_^Ai@Cv-dF&(vnudG?0CsddG_&Wtae(n|K59ew)6St z#dj7_(Cfwzh$H$5M!$UDd8=4>IQsD3xV=lXUq($;(h*$0^yd+b{qq63f0r_de#!o_ zXDngc>zy`uor)4A^2M#U*DC~i+dc<)Tb1Tv&~Ev@oM)5iJ4Sn#8iRw16XXuV50BS7 zdBL5Mefch(&^{luE{*5qtCZk$oFr3RH=H!c3wGR=HJ(yKc_re_X9pD` zJ;uxPzUfVpgU>DSq?J;I@a+10l0ONXPcDkiYcihREt5~T5Gb}sT0+6Q;AWHl`S5dV>lv%-p9l#xNNy7ZCr%cyqHY%TZ8Q4 zbp&#ov1*$#grNG#1vgfFOLJCaNG@K|2!W&HSh@3@Y%T?3YI75bJp!VP*$*!< z;(ffNS_;@RJ`=c7yX04!u3JP*<8jeqLHVJu#WV&v6wA!OYJS4h<_}^QI&97-;=ojW zQ-1t)7wnxG*5I%U4)9$wlv5Fr;cIizft@&N+32O%B{R1POm$oap@&f| zh+5J{>U6ftv|vAeKGc|zC=kO(+l7_cLpV}-D#oUltScw})N>~JOZLU_0{Ka2e1evz z{^a*ZrLr+JUj;)K&u2CoCAXLC2=fVScI(m_p~0FmF>>&3DHziouln?;sxW`NB}cSX z8?IsJB)Z=aYRz!X=yJn$kyOWK%rCYf-YarNqKzmWu$ZvkP12b4qH zhS9Q>j<}(*frr?z<%9hl*i^#@*O2q(Z^CN)c2c z>1B~D;@YpG?G!Yk+*yn4vM4sO-_!&m6+`k|3zd;8DJnxsBYtI;W3We+FN@|tQ5EW= z!VU>jtim0Mw#iaT8t_<+qKIEB-WwE04lBd%Letbml9N!?SLrEG$nmn7&W(W`VB@5S zaY=sEw2}i@F_1P4OtEw?xj4@D6>_e=m=797#hg}f*l^`AB|Y0# z9=)o|%TZFCY$SzgSjS|8AI-%J4x}J)!IMxY3_KYze`_I=c1nmrk@E8c9?MVRu)7+Ue79|)rBX7tVB7U|w4*h(;Gi3D9le49B38`wuv zp7{4X^p+K4*$@gU(Tq3K1a#3SmYhvI42)GzG4f|u zwQFT1n_=n|jpi=70-yE9LA+d*T8u z`=VmmXJ_f6WmZveZPct$Cgu^~gFiyL>Lnpj*6ee>*0pz=t$IJ}+rE zsf@>jlcG%Wx;Cp5x)YSVvB1$yyY1l&o zvwX=D7k)Dn;ciX?Z)Pn8$flC8#m`nB&(8?RSdBvr?>T9?E$U3uIX7T?$v4dWCa46 z+&`ot8ZTEgp7G+c52oHJ8nw5}a^dwb_l%MOh(ebVj9>_koQP^$2B~eUfSbw9RY$_< z&DDWf2LW;b0ZDOaZ&2^i^g+5uTd;GwO(-bbo|P^;CNL-%?9mRmxEw~5&z=X^Rvbo^WJW=n_%*7974RY}JhFv46> zd}`2|qkd;89l}R;i~9T)V-Q%K)O=yfVKNM4Gbacc7AOd>#^&W&)Xx!Uy5!BHnp9kh z`a(7MO6+Ren#>R^D0K)1sE{Bv>}s6Rb9MT14u!(NpZOe-?4V=>qZ>}uS)!y~;jEUK z&!U7Fj&{WdgU#L0%bM}SYXRtM5z!6M+kgaMKt%3FkjWYh=#QUpt$XX1!*XkpSq-pl zhMe{muh#knk{9_V3%qdDcWDv}v)m4t9 zQhv{;} zc{}#V^N3H>9mFM8`i`0p+fN@GqX+kl|M94$BK3J-X`Hyj8r!#x6Vt(PXjn?N)qedP z=o1T^#?1^a{;bZ&x`U{f?}TMo8ToN zkHj5v|}r}wDEi7I@)Gj+S1aE-GdnLN+$hw!=DzglMaj#{qjXi_dwpr|HL(gcCXwGLEmi|{4&4#OZ4ChceA zKVd4K!D>_N=_X;{poT~4Q+!Le+ZV>=H7v1*l%w`|`Dx8{)McN@NDlQyln&N3@bFpV z_1w~O4EH3fF@IzJ9kDk@7@QctFq8FbkbaH7K$iX=bV~o#gfh?2JD6lZf(XP>~DACF)fGFt)X%-h1yY~MJU{nA5 ze2zxWMs{YdX3q5XU*9hOH0!_S24DOBA5usB+Ws$6{|AMe*joJ?RxfV}*7AKN9V*~J zK+OMcE@bTD>TG1*yc?*qGqjBN8mgg@h1cJLDv)0!WRPIkC` zZrWXrceVw;fB%3`6kq=a!pq|hFIsQ%ZSlo~)D z|64!aCnw-?>}AG|*iOl44KVf8@|joXi&|)1rB;EQWgm+iHfVbgllP$f!$Wf42%NO5b(j9Bw6L z;0dpUUK$5GX4QbMlTmLM_jJt!ur`_0~$b#BB7FL*%XFf<b__1o)Ao3rlobbN8-(T!1d-bR8D3S0@d zLI!*GMb5s~Q<&sjd}lBb8Nr0>PqE6_!3!2d(KAWFxa{hm`@u|a(%#i(#f8{BP2wbs zt+N_slWF4IF_O|{w`c~)Xvh&R{Au~CFmW#0+}MBd2~X}t9lz6*E7uAD`@EBDe$>7W zzPUkJx<`f$0VA$=>R57^(K^h86>09?>_@M(R4q($!Ck6GG@pnu-x*exAx1jOv|>KH zjNfG5pwm`E-=ydcb+3BJwuU;V&OS=6yM^4Jq{%AVqnTTLwV`AorIDD}T&jWr8pB&j28fVtk_y*JRP^t@l*($UZ z6(B^-PBNZ+z!p?+e8@$&jCv^EWLb$WO=}Scr$6SM*&~B95El~;W_0(Bvoha|uQ1T< zO$%_oLAwf1bW*rKWmlD+@CP&$ObiDy=nh1b2ejz%LO9937N{LDe7gle4i!{}I$;&Y zkexJ9Ybr+lrCmKWg&}p=`2&Gf10orS?4$VrzWidT=*6{KzOGMo?KI0>GL0{iFWc;C z+LPq%VH5g}6V@-tg2m{C!-$fapJ9y}c$U}aUmS{9#0CM*8pC|sfer!)nG7Ji>mfRh z+~6CxNb>6eWKMHBz-w2{mLLwdA7dA-qfTu^A2yG1+9s5k zcF=le_UPYG&q!t5Zd_*E_P3Cf5T6821bO`daa`;DODm8Ih8k89=RN;-asHIigj`n=ux>*f!OC5#;X5i;Q z+V!GUy0|&Y_*8k_QRUA8$lHP;GJ3UUD08P|ALknng|YY13)}!!HW@0z$q+kCH%xet zlWf@BXQ=b=4}QO5eNnN~CzWBbHGUivG=`&eWK}beuV*;?zt=P#pM*eTuy3 zP}c#}AXJ0OIaqXji78l;YrP4sQe#^pOqwZUiiN6^0RCd#D271XCbEKpk`HI0IsN^s zES7YtU#7=8gTn#lkrc~6)R9u&SX6*Jk4GFX7){E)WE?pT8a-%6P+zS6o&A#ml{$WX zABFz#i7`DDlo{34)oo?bOa4Z_lNH>n;f0nbt$JfAl~;4QY@}NH!X|A$KgMmEsd^&Y zt;pi=>AID7ROQfr;MsMtClr5b0)xo|fwhc=qk33wQ|}$@?{}qXcmECh>#kUQ-If0$ zseb{Wf4VFGLNc*Rax#P8ko*=`MwaR-DQ8L8V8r=2N{Gaips2_^cS|oC$+yScRo*uF zUO|5=?Q?{p$inDpx*t#Xyo6=s?bbN}y>NNVxj9NZCdtwRI70jxvm3!5R7yiWjREEd zDUjrsZhS|P&|Ng5r+f^kA6BNN#|Se}_GF>P6sy^e8kBrgMv3#vk%m}9PCwUWJg-AD zFnZ=}lbi*mN-AOm zCs)r=*YQAA!`e#1N>aHF=bb*z*hXH#Wl$z^o}x##ZrUc=kh%OHWhp=7;?8%Xj||@V?1c ziWoaC$^&04;A|T)!Zd9sUzE&$ODyJaBpvqsw19Uiuq{i#VK1!htkdRWBnb z`{rat=nHArT%^R>u#CjjCkw-7%g53|&7z-;X+ewb?OLWiV|#nuc8mp*LuGSi3IP<<*Wyo9GKV7l0Noa4Jr0g3p_$ z*R9{qn=?IXC#WU>48-k5V2Oc_>P;4_)J@bo1|pf=%Rcbgk=5m)CJZ`caHBTm3%!Z9 z_?7LHr_BXbKKr=JD!%?KhwdYSdu8XxPoA{n8^%_lh5cjRHuCY9Zlpz8g+$f@bw@0V z+6DRMT9c|>1^3D|$Vzc(C?M~iZurGH2pXPT%F!JSaAMdO%!5o0uc&iqHx?ImcX6fI zCApkzc~OOnfzAd_+-DcMp&AOQxE_EsMqKM{%dRMI5`5CT&%mQO?-@F6tE*xL?aEGZ z8^wH@wRl`Izx4sDmU>}Ym{ybUm@F83qqZPD6nFm?t?(7>h*?`fw)L3t*l%*iw0Qu#?$5eq!Qc zpQvqgSxrd83NsdO@lL6#{%lsYXWen~d3p4fGBb7&5xqNYJ)yn84!e1PmPo7ChVd%4 zHUsV0Mh?VpzZD=A6%)Qrd~i7 z96*RPbid;BN{Wh?adeD_p8YU``kOrGkNox3D9~!K?w>#kFz!4lzOWR}puS(DmfjJD z`x0z|qB33*^0mZdM&6$|+T>fq>M%yoy(BEjuh9L0>{P&XJ3enGpoQRx`v6$txXt#c z0#N?b5%srj(4xmPvJxrlF3H%OMB!jvfy z;wx8RzU~lb?h_}@V=bh6p8PSb-dG|-T#A?`c&H2`_!u+uenIZe`6f~A7r)`9m8atC zt(b|6Eg#!Q*DfRU=Ix`#B_dK)nnJ_+>Q<1d7W)eynaVn`FNuN~%B;uO2}vXr5^zi2 z!ifIF5@Zlo0^h~8+ixFBGqtweFc`C~JkSq}&*a3C}L?b5Mh-bW=e)({F_g4O3 zb@SFTK3VD9QuFgFnK4Ve_pXc3{S$=+Z;;4+;*{H}Rc;845rP?DLK6G5Y-xdUKkA6E3Dz&5f{F^FjJQ(NSpZ8q-_!L3LL@H* zxbDF{gd^U3uD;)a)sJwAVi}7@%pRM&?5IaUH%+m{E)DlA_$IA1=&jr{KrhD5q&lTC zAa3c)A(K!{#nOvenH6XrR-y>*4M#DpTTOGQEO5Jr6kni9pDW`rvY*fs|ItV;CVITh z=`rxcH2nEJpkQ^(;1c^hfb8vGN;{{oR=qNyKtR1;J>CByul*+=`NydWnSWJR#I2lN zTvgnR|MBx*XFsfdA&;tr^dYaqRZp*2NwkAZE6kV@1f{76e56eUmGrZ>MDId)oqSWw z7d&r3qfazg+W2?bT}F)4jD6sWaw`_fXZGY&wnGm$FRPFL$HzVTH^MYBHWGCOk-89y zA+n+Q6EVSSCpgC~%uHfvyg@ufE^#u?JH?<73A}jj5iILz4Qqk5$+^U(SX(-qv5agK znUkfpke(KDn~dU0>gdKqjTkVk`0`9^0n_wzXO7R!0Thd@S;U`y)VVP&mOd-2 z(hT(|$=>4FY;CBY9#_lB$;|Wd$aOMT5O_3}DYXEHn&Jrc3`2JiB`b6X@EUOD zVl0S{ijm65@n^19T3l%>*;F(?3r3s?zY{thc4%AD30CeL_4{8x6&cN}zN3fE+x<9; zt2j1RRVy5j22-8U8a6$pyT+<`f+x2l$fd_{qEp_bfxfzu>ORJsXaJn4>U6oNJ#|~p z`*ZC&NPXl&=vq2{Ne79AkQncuxvbOG+28*2wU$R=GOmns3W@HE%^r)Fu%Utj=r9t` zd;SVOnA(=MXgnOzI2@3SGKHz8HN~Vpx&!Ea+Df~`*n@8O=0!b4m?7cE^K*~@fqv9q zF*uk#1@6Re_<^9eElgJD!nTA@K9C732tV~;B`hzZ321Ph=^BH?zXddiu{Du5*IPg} zqDM=QxjT!Rp|#Bkp$(mL)aar)f(dOAXUiw81pX0DC|Y4;>Vz>>DMshoips^8Frdv} zlTD=cKa48M>dR<>(YlLPOW%rokJZNF2gp8fwc8b2sN+i6&-pHr?$rj|uFgktK@jg~ zIFS(%=r|QJ=$kvm_~@n=ai1lA{7Z}i+zj&yzY+!t$iGUy|9jH#&oTNJ;JW-3n>DF+ z3aCOzqn|$X-Olu_p7brzn`uk1F*N4@=b=m;S_C?#hy{&NE#3HkATrg?enaVGT^$qIjvgc61y!T$9<1B@?_ibtDZ{G zeXInVr5?OD_nS_O|CK3|RzzMmu+8!#Zb8Ik;rkIAR%6?$pN@d<0dKD2c@k2quB%s( zQL^<_EM6ow8F6^wJN1QcPOm|ehA+dP(!>IX=Euz5qqIq}Y3;ibQtJnkDmZ8c8=Cf3 zu`mJ!Q6wI7EblC5RvP*@)j?}W=WxwCvF3*5Up_`3*a~z$`wHwCy)2risye=1mSp%p zu+tD6NAK3o@)4VBsM!@);qgsjgB$kkCZhaimHg&+k69~drbvRTacWKH;YCK(!rC?8 zP#cK5JPHSw;V;{Yji=55X~S+)%(8fuz}O>*F3)hR;STU`z6T1aM#Wd+FP(M5*@T1P z^06O;I20Sk!bxW<-O;E081KRdHZrtsGJflFRRFS zdi5w9OVDGSL3 zNrC7GVsGN=b;YH9jp8Z2$^!K@h=r-xV(aEH@#JicPy;A0k1>g1g^XeR`YV2HfmqXY zYbRwaxHvf}OlCAwHoVI&QBLr5R|THf?nAevV-=~V8;gCsX>jndvNOcFA+DI+zbh~# zZ7`qNk&w+_+Yp!}j;OYxIfx_{f0-ONc?mHCiCUak=>j>~>YR4#w# zuKz~UhT!L~GfW^CPqG8Lg)&Rc6y^{%3H7iLa%^l}cw_8UuG;8nn9)kbPGXS}p3!L_ zd#9~5CrH8xtUd?{d2y^PJg+z(xIfRU;`}^=OlehGN2=?}9yH$4Rag}*+AWotyxfCJ zHx=r7ZH>j2kV?%7WTtp+-HMa0)_*DBBmC{sd$)np&GEJ__kEd`xB5a2A z*J+yx>4o#ZxwA{;NjhU*1KT~=ZK~GAA;KZHDyBNTaWQ1+;tOFFthnD)DrCn`DjBZ% zk$N5B4^$`n^jNSOr=t(zi8TN4fpaccsb`zOPD~iY=UEK$0Y70bG{idLx@IL)7^(pL z{??Bnu=lDeguDrd%qW1)H)H`9otsOL-f4bSu};o9OXybo6J!Lek`a4ff>*O)BDT_g z<6@SrI|C9klY(>_PfA^qai7A_)VNE4c^ZjFcE$Isp>`e5fLc)rg@8Q_d^Uk24$2bn z9#}6kZ2ZxS9sI(RqT7?El2@B+($>eBQrNi_k#CDJ8D9}8$mmm z4oSKO^F$i+NG)-HE$O6s1--6EzJa?C{x=QgK&c=)b(Q9OVoAXYEEH20G|q$}Hue%~ zO3B^bF=t7t48sN zWh_zA`w~|){-!^g?6Mqf6ieV zFx~aPUOJGR=4{KsW7I?<=J2|lY`NTU=lt=%JE9H1vBpkcn=uq(q~=?iBt_-r(PLBM zP-0dxljJO>4Wq-;stY)CLB4q`-r*T$!K2o}?E-w_i>3_aEbA^MB7P5piwt1dI-6o!qWCy0 ztYy!x9arGTS?kabkkyv*yxvsPQ7Vx)twkS6z2T@kZ|kb8yjm+^$|sEBmvACeqbz)RmxkkDQX-A*K!YFziuhwb|ym>C$}U|J)4y z$(z#)GH%uV6{ec%Zy~AhK|+GtG8u@c884Nq%w`O^wv2#A(&xH@c5M`Vjk*SR_tJnq z0trB#aY)!EKW_}{#L3lph5ow=@|D5LzJYUFD6 z7XnUeo_V0DVSIKMFD_T0AqAO|#VFDc7c?c-Q%#u00F%!_TW1@JVnsfvm@_9HKWflBOUD~)RL``-!P;(bCON_4eVdduMO>?IrQ__*zE@7(OX zUtfH@AX*53&xJW*Pu9zcqxGiM>xol0I~QL5B%Toog3Jlenc^WbVgeBvV8C8AX^Vj& z^I}H})B=VboO%q1;aU5ACMh{yK4J;xlMc`jCnZR^!~LDs_MP&8;dd@4LDWw~*>#OT zeZHwdQWS!tt5MJQI~cw|Ka^b4c|qyd_ly(+Ql2m&AAw^ zQeSXDOOH!!mAgzAp0z)DD>6Xo``b6QwzUV@w%h}Yo>)a|xRi$jGuHQhJVA%>)PUvK zBQ!l0hq<3VZ*RnrDODP)>&iS^wf64C;MGqDvx>|p;35%6(u+IHoNbK z;Gb;TneFo*`zUKS6kwF*&b!U8e5m4YAo03a_e^!5BP42+r)LFhEy?_7U1IR<; z^0v|DhCYMSj<-;MtY%R@Fg;9Kky^pz_t2nJfKWfh5Eu@_l{^ph%1z{jkg5jQrkvD< z#vdK!nku*RrH~TdN~`wDs;d>XY1PH?O<4^U4lmA|wUW{Crrv#r%N>7k#{Gc44Fr|t z@UZP}Y-TrAmnEZ39A*@6;ccsR>)$A)S>$-Cj!=x$rz7IvjHIPM(TB+JFf{ehuIvY$ zsDAwREg*%|=>Hw$`us~RP&3{QJg%}RjJKS^mC_!U;E5u>`X`jW$}P`Mf}?7G7FX#{ zE(9u1SO;3q@ZhDL9O({-RD+SqqPX)`0l5IQu4q)49TUTkxR(czeT}4`WV~pV*KY&i zAl3~X%D2cPVD^B43*~&f%+Op)wl<&|D{;=SZwImydWL6@_RJjxP2g)s=dH)u9Npki zs~z9A+3fj0l?yu4N0^4aC5x)Osnm0qrhz@?nwG_`h(71P znbIewljU%T*cC=~NJy|)#hT+lx#^5MuDDnkaMb*Efw9eThXo|*WOQzJ*#3dmRWm@! zfuSc@#kY{Um^gBc^_Xdxnl!n&y&}R4yAbK&RMc+P^Ti;YIUh|C+K1|=Z^{nZ}}rxH*v{xR!i%qO~o zTr`WDE@k$M9o0r4YUFFeQO7xCu_Zgy)==;fCJ94M_rLAv&~NhfvcLWCoaGg2ao~3e zBG?Ms9B+efMkp}7BhmISGWmJsKI@a8b}4lLI48oWKY|8?zuuNc$lt5Npr+p7a#sWu zh!@2nnLBVJK!$S~>r2-pN||^w|fY`CT{TFnJy`B|e5;=+_v4l8O-fkN&UQbA4NKTyntd zqK{xEKh}U{NHoQUf!M=2(&w+eef77VtYr;xs%^cPfKLObyOV_9q<(%76-J%vR>w9!us-0c-~Y?_EVS%v!* z15s2s3eTs$Osz$JayyH|5nPAIPEX=U;r&p;K14G<1)bvn@?bM5kC{am|C5%hyxv}a z(DeSKI5ZfZ1*%dl8frIX2?);R^^~LuDOpNpk-2R8U1w92HmG1m&|j&J{EK=|p$;f9 z7Rs5|jr4r8k5El&qcuM+YRlKny%t+1CgqEWO>3;BSRZi(LA3U%Jm{@{y+A+w(gzA< z7dBq6a1sEWa4cD0W7=Ld9z0H7RI^Z7vl(bfA;72j?SWCo`#5mVC$l1Q2--%V)-uN* z9ha*s-AdfbDZ8R8*fpwjzx=WvOtmSzGFjC#X)hD%Caeo^OWjS(3h|d9_*U)l%{Ab8 zfv$yoP{OuUl@$(-sEVNt{*=qi5P=lpxWVuz2?I7Dc%BRc+NGNw+323^ z5BXGfS71oP^%apUo(Y#xkxE)y?>BFzEBZ}UBbr~R4$%b7h3iZu3S(|A;&HqBR{nK& z$;GApNnz=kNO^FL&nYcfpB7Qg;hGJPsCW44CbkG1@l9pn0`~oKy5S777uH)l{irK!ru|X+;4&0D;VE*Ii|<3P zUx#xUqvZT5kVQxsF#~MwKnv7;1pR^0;PW@$@T7I?s`_rD1EGUdSA5Q(C<>5SzE!vw z;{L&kKFM-MO>hy#-8z`sdVx})^(Dc-dw;k-h*9O2_YZw}|9^y-|8RQ`BWJUJL(Cer zP5Z@fNc>pTXABbTRY-B5*MphpZv6#i802giwV&SkFCR zGMETyUm(KJbh+&$8X*RB#+{surjr;8^REEt`2&Dubw3$mx>|~B5IKZJ`s_6fw zKAZx9&PwBqW1Oz0r0A4GtnZd7XTKViX2%kPfv+^X3|_}RrQ2e3l=KG_VyY`H?I5&CS+lAX5HbA%TD9u6&s#v!G> zzW9n4J%d5ye7x0y`*{KZvqyXUfMEE^ZIffzI=Hh|3J}^yx7eL=s+TPH(Q2GT-sJ~3 zI463C{(ag7-hS1ETtU;_&+49ABt5!A7CwLwe z=SoA8mYZIQeU;9txI=zcQVbuO%q@E)JI+6Q!3lMc=Gbj(ASg-{V27u>z2e8n;Nc*pf}AqKz1D>p9G#QA+7mqqrEjGfw+85Uyh!=tTFTv3|O z+)-kFe_8FF_EkTw!YzwK^Hi^_dV5x-Ob*UWmD-})qKj9@aE8g240nUh=g|j28^?v7 zHRTBo{0KGaWBbyX2+lx$wgXW{3aUab6Bhm1G1{jTC7ota*JM6t+qy)c5<@ zpc&(jVdTJf(q3xB=JotgF$X>cxh7k*(T`-V~AR+`%e?YOeALQ2Qud( zz35YizXt(aW3qndR}fTw1p()Ol4t!D1pitGNL95{SX4ywzh0SF;=!wf=?Q?_h6!f* zh7<+GFi)q|XBsvXZ^qVCY$LUa{5?!CgwY?EG;*)0ceFe&=A;!~o`ae}Z+6me#^sv- z1F6=WNd6>M(~ z+092z>?Clrcp)lYNQl9jN-JF6n&Y0mp7|I0dpPx+4*RRK+VQI~>en0Dc;Zfl+x z_e_b7s`t1_A`RP3$H}y7F9_na%D7EM+**G_Z0l_nwE+&d_kc35n$Fxkd4r=ltRZhh zr9zER8>j(EdV&Jgh(+i}ltESBK62m0nGH6tCBr90!4)-`HeBmz54p~QP#dsu%nb~W z7sS|(Iydi>C@6ZM(Us!jyIiszMkd)^u<1D+R@~O>HqZIW&kearPWmT>63%_t2B{_G zX{&a(gOYJx!Hq=!T$RZ&<8LDnxsmx9+TBL0gTk$|vz9O5GkK_Yx+55^R=2g!K}NJ3 zW?C;XQCHZl7H`K5^BF!Q5X2^Mj93&0l_O3Ea3!Ave|ixx+~bS@Iv18v2ctpSt4zO{ zp#7pj!AtDmti$T`e9{s^jf(ku&E|83JIJO5Qo9weT6g?@vX!{7)cNwymo1+u(YQ94 zopuz-L@|5=h8A!(g-MXgLJC0MA|CgQF8qlonnu#j z;uCeq9ny9QSD|p)9sp3ebgY3rk#y0DA(SHdh$DUm^?GI<>%e1?&}w(b zdip1;P2Z=1wM+$q=TgLP$}svd!vk+BZ@h<^4R=GS2+sri7Z*2f`9 z5_?i)xj?m#pSVchk-SR!2&uNhzEi+#5t1Z$o0PoLGz*pT64%+|Wa+rd5Z}60(j?X= z{NLjtgRb|W?CUADqOS@(*MA-l|E342NxRaxLTDqsOyfWWe%N(jjBh}G zm7WPel6jXijaTiNita+z(5GCO0NM=Melxud57PP^d_U## zbA;9iVi<@wr0DGB8=T9Ab#2K_#zi=$igyK48@;V|W`fg~7;+!q8)aCOo{HA@vpSy-4`^!ze6-~8|QE||hC{ICKllG9fbg_Y7v z$jn{00!ob3!@~-Z%!rSZ0JO#@>|3k10mLK0JRKP-Cc8UYFu>z93=Ab-r^oL2 zl`-&VBh#=-?{l1TatC;VweM^=M7-DUE>m+xO7Xi6vTEsReyLs8KJ+2GZ&rxw$d4IT zPXy6pu^4#e;;ZTsgmG+ZPx>piodegkx2n0}SM77+Y*j^~ICvp#2wj^BuqRY*&cjmL zcKp78aZt>e{3YBb4!J_2|K~A`lN=u&5j!byw`1itV(+Q_?RvV7&Z5XS1HF)L2v6ji z&kOEPmv+k_lSXb{$)of~(BkO^py&7oOzpjdG>vI1kcm_oPFHy38%D4&A4h_CSo#lX z2#oqMCTEP7UvUR3mwkPxbl8AMW(e{ARi@HCYLPSHE^L<1I}OgZD{I#YH#GKnpRmW3 z2jkz~Sa(D)f?V?$gNi?6)Y;Sm{&?~2p=0&BUl_(@hYeX8YjaRO=IqO7neK0RsSNdYjD zaw$g2sG(>JR=8Iz1SK4`*kqd_3-?;_BIcaaMd^}<@MYbYisWZm2C2|Np_l|8r9yM|JkUngSo@?wci(7&O9a z%|V(4C1c9pps0xxzPbXH=}QTxc2rr7fXk$9`a6TbWKPCz&p=VsB8^W96W=BsB|7bc zf(QR8&Ktj*iz)wK&mW`#V%4XTM&jWNnDF56O+2bo<3|NyUhQ%#OZE8$Uv2a@J>D%t zMVMiHh?es!Ex19q&6eC&L=XDU_BA&uR^^w>fpz2_`U87q_?N2y;!Z!bjoeKrzfC)} z?m^PM=(z{%n9K`p|7Bz$LuC7!>tFOuN74MFELm}OD9?%jpT>38J;=1Y-VWtZAscaI z_8jUZ#GwWz{JqvGEUmL?G#l5E=*m>`cY?m*XOc*yOCNtpuIGD+Z|kn4Xww=BLrNYS zGO=wQh}Gtr|7DGXLF%|`G>J~l{k^*{;S-Zhq|&HO7rC_r;o`gTB7)uMZ|WWIn@e0( zX$MccUMv3ABg^$%_lNrgU{EVi8O^UyGHPNRt%R!1#MQJn41aD|_93NsBQhP80yP<9 zG4(&0u7AtJJXLPcqzjv`S~5;Q|5TVGccN=Uzm}K{v)?f7W!230C<``9(64}D2raRU zAW5bp%}VEo{4Rko`bD%Ehf=0voW?-4Mk#d3_pXTF!-TyIt6U+({6OXWVAa;s-`Ta5 zTqx&8msH3+DLrVmQOTBOAj=uoxKYT3DS1^zBXM?1W+7gI!aQNPYfUl{3;PzS9*F7g zWJN8x?KjBDx^V&6iCY8o_gslO16=kh(|Gp)kz8qlQ`dzxQv;)V&t+B}wwdi~uBs4? zu~G|}y!`3;8#vIMUdyC7YEx6bb^1o}G!Jky4cN?BV9ejBfN<&!4M)L&lRKiuMS#3} z_B}Nkv+zzxhy{dYCW$oGC&J(Ty&7%=5B$sD0bkuPmj7g>|962`(Q{ZZMDv%YMuT^KweiRDvYTEop3IgFv#)(w>1 zSzH>J`q!LK)c(AK>&Ib)A{g`Fdykxqd`Yq@yB}E{gnQV$K!}RsgMGWqC3DKE(=!{}ekB3+(1?g}xF>^icEJbc z5bdxAPkW90atZT+&*7qoLqL#p=>t-(-lsnl2XMpZcYeW|o|a322&)yO_8p(&Sw{|b zn(tY$xn5yS$DD)UYS%sP?c|z>1dp!QUD)l;aW#`%qMtQJjE!s2z`+bTSZmLK7SvCR z=@I4|U^sCwZLQSfd*ACw9B@`1c1|&i^W_OD(570SDLK`MD0wTiR8|$7+%{cF&){$G zU~|$^Ed?TIxyw{1$e|D$050n8AjJvvOWhLtLHbSB|HIfhMpqVf>AF&}ZQHhOJ14Bz zww+XL+qP}nww+W`F>b!by|=&a(cM4JIDhsTXY8@|ntQG}-}jm0&Bcj|LV(#sc=BNS zRjh;k9l>EdAFdd)=H!U`~$WP*}~^3HZ_?H>gKw>NBa;tA8M1{>St|)yDF_=~{KEPAGkg3VB`QCHol!AQ0|?e^W?81f{@()Wy!vQ$bY; z0ctx)l7VK83d6;dp!s{Nu=SwXZ8lHQHC*J2g@P0a={B8qHdv(+O3wV=4-t4HK1+smO#=S; z3cSI#Nh+N@AqM#6wPqjDmQM|x95JG|l1#sAU|>I6NdF*G@bD?1t|ytHlkKD+z9}#j zbU+x_cR-j9yX4s{_y>@zk*ElG1yS({BInGJcIT>l4N-DUs6fufF#GlF2lVUNOAhJT zGZThq54GhwCG(h4?yWR&Ax8hU<*U)?g+HY5-@{#ls5CVV(Wc>Bavs|l<}U|hZn z_%m+5i_gaakS*Pk7!v&w3&?R5Xb|AkCdytTY;r+Z7f#Id=q+W8cn)*9tEet=OG+Y} z58U&!%t9gYMx2N=8F?gZhIjtkH!`E*XrVJ?$2rRxLhV1z82QX~PZi8^N5z6~f-MUE zLKxnNoPc-SGl7{|Oh?ZM$jq67sSa)Wr&3)0YxlJt(vKf!-^L)a|HaPv*IYXb;QmWx zsqM>qY;tpK3RH-omtta+Xf2Qeu^$VKRq7`e$N-UCe1_2|1F{L3&}M0XbJ@^xRe&>P zRdKTgD6601x#fkDWkoYzRkxbn#*>${dX+UQ;FbGnTE-+kBJ9KPn)501#_L4O_k`P3 zm+$jI{|EC?8BXJY{P~^f-{**E53k%kVO$%p+=H5DiIdwMmUo>2euq0UzU90FWL!>; z{5@sd0ecqo5j!6AH@g6Mf3keTP$PFztq}@)^ZjK;H6Go$#SV2|2bAFI0%?aXgVH$t zb4Kl`$Xh8qLrMbZUS<2*7^F0^?lrOE=$DHW+O zvLdczsu0^TlA6RhDy3=@s!k^1D~Awulk!Iyo#}W$xq8{yTAK!CLl={H0@YGhg-g~+ z(u>pss4k#%8{J%~%8=H5!T`rqK6w^es-cNVE}=*lP^`i&K4R=peg1tdmT~UAbDKc& zg%Y*1E{hBf<)xO>HDWV7BaMWX6FW4ou1T2m^6{Jb!Su1UaCCYY8RR8hAV$7ho|FyEyP~ zEgK`@%a$-C2`p zV*~G>GOAs*3KN;~IY_UR$ISJxB(N~K>=2C2V6>xTmuX4klRXdrJd&UPAw7&|KEwF8Zcy2j-*({gSNR1^p02Oj88GN9a_Hq;Skdp}kO0;FLbje%2ZvPiltDZgv^ z#pb4&m^!79;O8F+Wr9X71laPY!CdNXG?J6C9KvdAE2xWW1>U~3;0v≫L+crb^Bz zc+Nw%zgpZ6>!A3%lau!Pw6`Y#WPVBtAfKSsqwYDWQK-~ zz(mx=nJ6-8t`YXB{6gaZ%G}Dmn&o500Y}2Rd?e&@=hBEmB1C=$OMBfxX__2c2O4K2#(0ksclP$SHp*8jq-1&(<6(#=6&H`Nlc2RVC4->r6U}sTY<1? zn@tv7XwUs-c>Lcmrm5AE0jHI5={WgHIow6cX=UK)>602(=arbuAPZ37;{HTJSIO%9EL`Et5%J7$u_NaC(55x zH^qX^H}*RPDx)^c46x>js=%&?y?=iFs^#_rUl@*MgLD92E5y4B7#EDe9yyn*f-|pQ zi>(!bIg6zY5fLSn@;$*sN|D2A{}we*7+2(4&EhUV%Qqo5=uuN^xt_hll7=`*mJq6s zCWUB|s$)AuS&=)T&_$w>QXHqCWB&ndQ$y4-9fezybZb0bYD^zeuZ>WZF{rc>c4s`` zgKdppTB|o>L1I1hAbnW%H%EkFt%yWC|0~+o7mIyFCTyb?@*Ho)eu(x`PuO8pLikN> z6YeI`V?AUWD(~3=8>}a6nZTu~#QCK(H0+4!ql3yS`>JX;j4+YkeG$ZTm33~PLa3L} zksw7@%e-mBM*cGfz$tS4LC^SYVdBLsR}nAprwg8h2~+Cv*W0%izK+WPVK}^SsL5R_ zpA}~G?VNhJhqx2he2;2$>7>DUB$wN9_-adL@TqVLe=*F8Vsw-yho@#mTD6*2WAr6B zjtLUh`E(;#p0-&$FVw(r$hn+5^Z~9J0}k;j$jL1;?2GN9s?}LASm?*Rvo@?E+(}F& z+=&M-n`5EIz%%F^e)nnWjkQUdG|W^~O|YeY4Fz}>qH2juEere}vN$oJN~9_Th^&b{ z%IBbET*E8%C@jLTxV~h#mxoRrJCF{!CJOghjuKOyl_!Jr?@4Upo7u>fTGtfm|CH2v z&9F+>;6aFbYXLj3{yZ~Yn1J2%!)A3~j2$`jOy{XavW@t)g}}KUVjCWG0OUc7aBc=2 zR3^u=dT47=5SmT{K1aGaVZkOx|24T-J0O$b9dfB25J|7yb6frwS6wZ1^y%EWOm}S< zc1SdYhfsdLG*FB-;!QLV3D!d~hnXTGVQVck9x%=B(Kk8c3y%f0nR95_TbY;l=obSl zEE@fp0|8Q$b3(+DXh?d0FEloGhO0#11CLQT5qtEckBLe-VN-I>9ys}PVK0r;0!jIG zH_q$;a`3Xv9P_V2ekV1SMzd#SKo<1~Dq2?M{(V;AwhH_2x@mN$=|=cG0<3o^j_0OF z7|WJ-f2G=7sA4NVGU2X5`o*D2T7(MbmZ2(oipooE{R?9!{WxX!%ofhsrPAxoIk!Kr z>I$a{Zq=%KaLrDCIL^gmA3z{2z%Wkr)b$QHcNUA^QwydWMJmxymO0QS22?mo%4(Md zgME(zE}ub--3*wGjV`3eBMCQG-@Gel1NKZDGuqobN|mAt0{@ZC9goI|BSmGBTUZ(`Xt z^e2LiMg?6E?G*yw(~K8lO(c4)RY7UWxrXzW^iCg-P41dUiE(i+gDmmAoB?XOB}+Ln z_}rApiR$sqNaT4frw69Wh4W?v(27IlK$Toy<1o)GeF+sGzYVeJ`F)3`&2WDi^_v67 zg;@ehwl3=t+}(DJtOYO!s`jHyo-}t@X|U*9^sIfaZfh;YLqEFmZ^E;$_XK}%eq;>0 zl?+}*kh)5jGA}3daJ*v1knbW0GusR1+_xD`MFPZc3qqYMXd>6*5?%O5pC7UVs!E-` zuMHc6igdeFQ`plm+3HhP)+3I&?5bt|V8;#1epCsKnz0%7m9AyBmz06r90n~9o;K30 z=fo|*`Qq%dG#23bVV9Jar*zRcV~6fat9_w;x-quAwv@BkX0{9e@y0NB(>l3#>82H6 z^US2<`=M@6zX=Pz>kb8Yt4wmeEo%TZ=?h+KP2e3U9?^Nm+OTx5+mVGDvgFee%}~~M zK+uHmj44TVs}!A}0W-A92LWE%2=wIma(>jYx;eVB*%a>^WqC7IVN9{o?iw{e4c=CG zC#i=cRJZ#v3 zF^9V+7u?W=xCY%2dvV_0dCP%5)SH*Xm|c#rXhwEl*^{Ar{NVoK*H6f5qCSy`+|85e zjGaKqB)p7zKNKI)iWe6A9qkl=rTjs@W1Crh(3G57qdT0w2ig^{*xerzm&U>YY{+fZbkQ#;^<$JniUifmAuEd^_M(&?sTrd(a*cD! zF*;`m80MrZ^> zaF{}rDhEFLeH#`~rM`o903FLO?qw#_Wyb5}13|0agjSTVkSI6Uls)xAFZifu@N~PM zQ%o?$k)jbY0u|45WTLAirUg3Zi1E&=G#LnSa89F3t3>R?RPcmkF}EL-R!OF_r1ZN` z?x-uHH+4FEy>KrOD-$KHg3$-Xl{Cf0;UD4*@eb~G{CK-DXe3xpEEls?SCj^p z$Uix(-j|9f^{z0iUKXcZQen}*`Vhqq$T?^)Ab2i|joV;V-qw5reCqbh(8N)c%!aB< zVs+l#_)*qH_iSZ_32E~}>=wUO$G_~k0h@ch`a6Wa zsk;<)^y=)cPpHt@%~bwLBy;>TNrTf50BAHUOtt#9JRq1ro{w80^sm-~fT>a$QC;<| zZIN%&Uq>8`Js_E((_1sewXz3VlX|-n8XCfScO`eL|H&2|BPZhDn}UAf_6s}|!XpmUr90v|nCutzMjb9|&}#Y7fj_)$alC zM~~D6!dYxhQof{R;-Vp>XCh1AL@d-+)KOI&5uKupy8PryjMhTpCZnSIQ9^Aq+7=Mb zCYCRvm4;H=Q8nZWkiWdGspC_Wvggg|7N`iED~Eap)Th$~wsxc(>(KI>{i#-~Dd8iQ zzonqc9DW1w4a*}k`;rxykUk+~N)|*I?@0901R`xy zN{20p@Ls<%`1G1Bx87Vm6Z#CA`QR(x@t8Wc?tpaunyV^A*-9K9@P>hAWW9Ev)E$gb z<(t?Te6GcJX2&0% z403pe>e)>m-^qlJU^kYIH)AutgOnq!J>FoMXhA-aEx-((7|(*snUyxa+5$wx8FNxS zKuVAVWArlK#kDzEM zqR?&aXIdyvxq~wF?iYPho*(h?k zD(SBpRDZ}z$A})*Qh!9&pZZRyNixD!8)B5{SK$PkVET(yd<8kImQ3ILe%jhx8Ga-1 zE}^k+Eo^?c4Y-t2_qXiVwW6i9o2qosBDj%DRPNT*UXI0=D9q{jB*22t4HHcd$T&Xi zT=Vte*Gz2E^qg%b7ev04Z&(;=I4IUtVJkg<`N6i7tjUn-lPE(Y4HPyJKcSjFnEzCH zPO(w%LmJ_=D~}PyfA91H4gCaf-qur3_KK}}>#9A}c5w@N;-#cHph=x}^mQ3`oo`Y$ope#)H9(kQK zGyt<7eNPuSAs$S%O>2ElZ{qtDIHJ!_THqTwcc-xfv<@1>IJ;YTv@!g-zDKBKAH<

Zet1e^8c}8fE97XH}+lF{qbF<`Y%dU|I!~Y`ZrVfKX82i z)(%!Tcf~eE^%2_`{WBPGPU@1NB5SCXe1sAI<4&n1IwO{&S$ThWn37heGOSW%nW7*L zxh0WK!E7zh%6yF-7%~l@I~b`2=*$;RYbi(I#zp$gL_d39U4A)KuB( zcS0bt48&%G_I~( zL(}w&2NA6#$=|g)J+-?ehHflD^lr77ngdz=dszFI;?~ZxeJv=gsm?4$$6#V==H{fa zqO!EkT>1-OQSJoX)cN}XsB;shvrHRwTH(I2^Ah4|rizn!V7T7fLh~Z<`Q+?zEMVxh z$=-x^RR*PlhkV_8mshTvs+zmZWY&Jk{9LX0Nx|+NAEq-^+Rh|ZlinVZ=e8=`WQt;e@= zPU}^1cG*O;G7l{Y#nl znp`y%CO_SC7gk0i0gY&phM04Y)~vU0!3$V$2T+h(1ZS+cCgc zaC?3M;B48^faGo>h~--#FNFauH?0BJJ6_nG5qOlr>k~%DCSJaOfl%KWHusw>tGrTxAhlEVDxc8R2C-)LCt&$Rt9IKor=ml7jirX@?WW+M z^I{b}MD5r$s>^^sN@&g`cXD~S_u09xo;{;noKZatIuzqd zW1e7oTl9>g8opPBT(p+&fo0F#!c{NFYYpIZ6u8hOB{F#{nP)@})X20$3iJtG$cO zJ$Oxl_qH{sL5d?=D$2M4C3Ajc;GN0(B-HVT;@pJ-LvIrN%|SY?t}g!J>ufQrR%hoY z!nr$tq~N%)9}^tEip93XW=MQ1@XovSvn`PTqXeT9@_7hGv4%LK1M**Q%UKi|(v@1_ zKGe*@+1%Y4v&`;5vUL`C&{tc+_7HFs7*OtjY8@Gg`C4O&#An{0xOvgNSehTHS~_1V z=daxCMzI5b_ydM5$z zZl`a{mM}i@x;=QyaqJY&{Q^R*^1Yzq!dHH~UwCCga+Us~2wk59ArIYtSw9}tEmjbo z5!JA=`=HP*Ae~Z4Pf7sC^A3@Wfa0Ax!8@H_&?WVe*)9B2y!8#nBrP!t1fqhI9jNMd zM_5I)M5z6Ss5t*f$Eh{aH&HBeh310Q~tRl3wCEcZ>WCEq%3tnoHE)eD=)XFQ7NVG5kM zaUtbnq2LQomJSWK)>Zz1GBCIHL#2E>T8INWuN4O$fFOKe$L|msB3yTUlXES68nXRX zP6n*zB+kXqqkpQ3OaMc9GqepmV?Ny!T)R@DLd`|p5ToEvBn(~aZ%+0q&vK1)w4v0* zgW44F2ixZj0!oB~^3k|vni)wBh$F|xQN>~jNf-wFstgiAgB!=lWzM&7&&OYS=C{ce zRJw|)PDQ@3koZfm`RQ$^_hEN$GuTIwoTQIDb?W&wEo@c75$dW(ER6q)qhF`{#7UTuPH&)w`F!w z0EKs}=33m}_(cIkA2rBWvApydi0HSOgc>6tu&+hmRSB%)s`v_NujJNhKLS3r6hv~- z)Hm@?PU{zd0Tga)cJWb2_!!9p3sP%Z zAFT|jy;k>4X)E>4fh^6=SxV5w6oo`mus&nWo*gJL zZH{SR!x)V)y=Qc7WEv-xLR zhD4OcBwjW5r+}pays`o)i$rcJb2MHLGPmeOmt5XJDg@(O3PCbxdDn{6qqb09X44T zh6I|s=lM6Nr#cGaA5-eq*T=LQ6SlRq*`~`b+dVi5^>el1p;#si6}kK}>w;1 z6B1dz{q_;PY{>DBQ+v@1pfXTd5a*^H9U*;qdj@XBF}MoSSQxVXeUpEM5Z0909&8$pRfR|B(t0ox&xl8{8mUNd#(zWONW{oycv$VjP1>q;jU@ z@+8E~fjz*I54OFFaQ{A5jn1w>r;l!NRlI(8q3*%&+tM?lov_G3wB`<}bQ>1=&xUht zmti5VZzV1Cx006Yzt|%Vwid>QPX8Nfa8|sue7^un@C+!3h!?-YK>lSfNIHh|0kL8v zbv_BklQ4HOqje|@Fyxn%IvL$N&?m(KN;%`I$N|muStjSsgG;gP4Smgz$2u(mG;DXP zf~uQ z212x^l6!MW>V@ORUGSFLAAjz3i5zO$=UmD_zhIk2OXUz^LkDLWjla*PW?l;`LLos> z7FBvCr)#)XBByDm(=n%{D>BcUq>0GOV9`i-(ZSI;RH1rdrAJ--f0uuAQ4odl z_^$^U_)0BBJwl@6R#&ZtJN+@a(4~@oYF)yG+G#3=)ll8O#Zv3SjV#zSXTW3h9kqn* z@AHL=vf~KMas}6{+u=}QFumr-!c=(BFP_dwvrdehzTyqco)m@xRc=6b#Dy+KD*-Bq zK=y*1VAPJ;d(b?$2cz{CUeG(0`k9_BIuUki@iRS5lp3=1#g)A5??1@|p=LOE|FNd; z-?5MLKd-5>yQ7n__5W^3C!_`hP(o%_E3BKEmo1h=H(7;{6$XRRW6{u+=oQX<((xAJ zNRY`Egtn#B1EBGHLy^eM5y}Jy0h!GAGhb7gZJoZI-9WuSRw)GVQAAcKd4Qm)pH`^3 zq6EIM}Q zxZGx%aLnNP1an=;o8p9+U^>_Bi`e23E^X|}MB&IkS+R``plrRzTE%ncmfvEW#AHJ~ znmJ`x&ez6eT21aLnoI`%pYYj zzQ?f^ob&Il;>6Fe>HPhAtTZa*B*!;;foxS%NGYmg!#X%)RBFe-acahHs3nkV61(E= zhekiPp1d@ACtA=cntbjuv+r-Zd`+lwKFdqZuYba_ey`&H<Psu;Tzwt;-LQxvv<_D5;ik7 zwETZe`+voUhk%$s2-7Rqfl`Ti_{(fydI(DAHKr<66;rYa6p8AD+NEc@Fd@%m`tiK% z=Mebzrtp=*Q%a}2UdK4J&5#tCN5PX>W=(9rUEXZ8yjRu+7)mFpKh{6;n%!bI(qA9kfyOtstGtOl zX!@*O0fly*L4k##fsm&V0j9Lj<_vu1)i?!#xTB7@2H&)$Kzt@r(GH=xRZlIimTDd_o(%9xO388LwC#;vQ?7OvRU_s< zDS@6@g}VnvQ+tn(C#sx0`J^T4WvFxYI17;uPs-Ub{R`J-NTdtBGl+Q>e81Z3#tDUr ztnVc*p{o|RNnMYts4pdw=P!uJkF@8~h)oV4dXu5F7-j0AW|=mt!QhP&ZV!!82*c7t zuOm>B*2gFtq;A8ynZ~Ms?!gEi5<{R_8tRN%aGM!saR4LJQ|?9w>Ff_61(+|ol_vL4 z-+N>fushRbkB4(e{{SQ}>6@m}s1L!-#20N&h%srA=L50?W9skMF9NGfQ5wU*+0<@> zLww8%f+E0Rc81H3e_5^DB@Dn~TWYk}3tqhO{7GDY;K7b*WIJ-tXnYM@z4rn(LGi?z z8%$wivs)fC#FiJh?(SbH-1bgdmHw&--rn7zBWe1xAhDdv#IRB@DGy}}zS%M0(F_3_ zLb-pWsdJ@xXE;=tpRAw?yj(Gz=i$;bsh&o2XN%24b6+?_gJDBeY zws3PE2u!#Cec>aFMk#ECxDlAs;|M7@LT8)Y4(`M}N6IQ{0YtcA*8e42!n^>`0$LFU zUCq2IR2(L`f++=85M;}~*E($nE&j;p{l%xchiTau*tB9bI= zn~Ygd@<+9DrXxoGPq}@vI1Q3iEfKRleuy*)_$+hg?+GOgf1r?d@Or42|s|D>XMa;ebr1uiTNUq@heusd6%WwJqyCCv!L*qou9l!B22H$bQ z)<)IA>Yo77S;|`fqBk!_PhLJEQb0wd1Z|`pCF;hol!34iQYtqu3K=$QxLW7(HFx~v>`vVRr zyqk^B4~!3F8t8Q_D|GLRrAbbQDf??D&Jd|mgw*t1YCd)CM2$76#Cqj1bD*vADwavp zS<`n@gLU4pwCqNPsIfHKl{5}gu9t-o+O< z??!fMqMrt$s}02pdBbOScUrc1T*{*-ideR6(1q4@oC6mxg8v8Y^h^^hfx6| z|Mld6Ax1CuSlmSJmHwdOix?$8emihK#&8&}u8m!#T1+c5u!H)>QW<7&R$eih)xkov zHvvEIJHbkt+2KQ<-bMR;2SYX?8SI=_<-J!GD5@P2FJ}K z5u82YFotCJF(dUeJFRX_3u8%iIYbRS??A?;iVO?84c}4Du9&jG<#urlZ_Unrcg8dR z!5I3%9F*`qwk#joKG_Q%5_xpU7|jm4h0+l$p;g%Tr>i74#3QnMXdz|1l2MQN$yw|5 zThMw15BxjWf2{KM)XtZ+e#N)ihlkxPe=5ymT9>@Ym%_LF}o z1XhCP`3E1A{iVoHA#|O|&5=w;=j*Qf`;{mBAK3={y-YS$`!0UmtrvzHBfR*s{z<0m zW>4C=%N98hZlUhwAl1X`rR)oL0&A`gv5X79??p_==g*n4$$8o5g9V<)F^u7v0Vv^n z1sp8{W@g6eWv2;A31Rhf5j?KJhITYfXWZsl^`7z`CFtnFrHUWiD?$pwU6|PQjs|7RA0o9ARk^9$f`u3&C|#Z3iYdh<0R`l2`)6+ z6tiDj@xO;Q5PDTYSxsx6n>bj+$JK8IPJ=U5#dIOS-zwyK?+t^V`zChdW|jpZuReE_ z)e~ywgFe!0q|jzsBn&(H*N`%AKpR@qM^|@qFai0};6mG_TvXjJ`;qZ{lGDZHScZk( z>pO+%icp)SaPJUwtIPo1BvGyP8E@~w2y}=^PnFJ$iHod^JH%j1>nXl<3f!nY9K$e` zq-?XYl)K`u*cVXM=`ym{N?z=dHQNR23M8uA-(vsA$6(xn+#B-yY!CB2@`Uz({}}w+ z0sni*39>rMC!Ay|1B@;al%T&xE(wCf+`3w>N)*LxZZZYi{5sqiVWgbNd>W*X?V}C- zjQ4F7e_uCUOHbtewQkq?m$*#@ZvWbu{4i$`aeKM8tc^ zL5!GL8gX}c+qNUtUIcps1S)%Gsx*MQLlQeoZz2y2OQb(A73Jc3`LmlQf0N{RTt;wa`6h|ljX1V7UugML=W5-STDbeWTiEMjPQ$({hn_s&NDXzs6?PLySp$?L`0ilH3vCUO{JS0Dp`z;Ry$6}R@1NdY7rxccbm$+;ApSe=2q!0 z()3$vYN0S$Cs)#-OBs{_2uFf}L4h$;7^2w20=l%5r9ui&pTEgg4U!FoCqyA6r2 zC5s72l}i*9y|KTjDE5gVlYe4I2gGZD)e`Py2gq7cK4at{bT~DSbQQ4Z4sl)kqXbbr zqvXtSqMrDdT2qt-%-HMoqeFEMsv~u)-NJ%Z*ipSJUm$)EJ+we|4*-Mi900K{K|e0; z1_j{X5)a%$+vM7;3j>skgrji92K1*Ip{SfM)=ob^E374JaF!C(cZ$R_E>Wv+?Iy9M z?@`#XDy#=z%3d9&)M=F8Xq5Zif%ldIT#wrlw(D_qOKo4wD(fyDHM5(wm1%7hy6euJ z%Edg!>Egs;ZC6%ktLFtyN0VvxN?*4C=*tOEw`{KQvS7;c514!FP98Nf#d#)+Y-wsl zP3N^-Pnk*{o(3~m=3DX$b76Clu=jMf9E?c^cbUk_h;zMF&EiVz*4I(rFoaHK7#5h0 zW7CQx+xhp}Ev+jw;SQ6P$QHINCxeF8_VX=F3&BWUd(|PVViKJl@-sYiUp@xLS2NuF z8W3JgUSQ&lUp@2E(7MG`sh4X!LQFa6;lInWqx}f#Q z4xhgK1%}b(Z*rZn=W{wBOe7YQ@1l|jQ|9ELiXx+}aZ(>{c7Ltv4d>PJf7f+qjRU8i%XZZFJkj&6D^s;!>`u%OwLa*V5Js9Y$b-mc!t@{C415$K38iVu zP7!{3Ff%i_e!^LzJWhBgQo=j5k<<($$b&%%Xm_f8RFC_(97&nk83KOy@I4k?(k<(6 zthO$3yl&0x!Pz#!79bv^?^85K5e7uS$ zJ33yka2VzOGUhQXeD{;?%?NTYmN3{b0|AMtr(@bCx+c=F)&_>PXgAG}4gwi>g82n> zL3DlhdL|*^WTmn;XPo62HhH-e*XIPSTF_h{#u=NY8$BUW=5@PD{P5n~g5XDg?Fzvb_u ziK&CJqod4srfY2T?+4x@)g9%3%*(Q2%YdCA3yM{s=+QD0&IM`8k8N&-6%iIL3kon> z0>p3BUe!lrz&_ZX2FiP%MeuQY-xVV%K?=bGPOM&XM0XRd7or< zy}jn_eEzuQ>t2fM9ict#ZNxD7HUycsq76IavfoNl$G1|t*qpUSX;YgpmJrr_8yOJ2 z(AwL;Ugi{gJ29@!G-mD82Z)46T`E+s86Qw|YSPO*OoooraA!8x_jQXYq5vUw!5f_x zubF$}lHjIWxFar8)tTg8z-FEz)a=xa`xL~^)jIdezZsg4%ePL$^`VN#c!c6`NHQ9QU zkC^<0f|Ksp45+YoX!Sv>+57q}Rwk*2)f{j8`d8Ctz^S~me>RSakEvxUa^Pd~qe#fb zN7rnAQc4u$*Y9p~li!Itp#iU=*D4>dvJ{Z~}kqAOBcL8ln3YjR{Sp!O`s=5yM zWRNP#;2K#+?I&?ZSLu)^z-|*$C}=0yi7&~vZE$s``IE^PY|dj^HcWI$9ZRm>3w(u` z-1%;;MJbzHFNd^!Ob!^PLO-xhhj@XrI81Y)x4@FdsI( za`o4Gy(`T$P?PB?s>o+eIOtuirMykbuAi65Y_UN1(?jTCy@J8Px`%;bcNmPm#Fr!= z5V!YViFJ!FBfEq>nJFk0^RAV1(7w+X`HRgP;nJHJdMa!}&vvduCMoslwHTes_I76|h>;(-9lbfGnt zoZomakOt759AuTX4b$)G8TzJ&m*BV8!vMs9#=e0tWa z%)84R=3?tfh72~=Rc;fXwj+x z+25xapYK@2@;}6)@8IL+F6iuJ_B{&A-0=U=U6WMbY>~ykVFp$XkH)f**b>TE5)shN z39E2L@JPCSl!?pkvFeh@6dCv9oE}|{GbbVM!XIgByN#md&tXy@>QscU0#z!I&X4;d z&B&ZA4lbrHJ!x4lCN4KC-)u#gT^cE{Xnhu`0RXVKn|j$vz8m}v^%*cQ{(h%FW8_8a zFM{$PirSI8@#*xg2T){A+EKX(eTC66Fb})w{vg%Vw)hvV-$tttI^V5wvU?a{(G}{G z@ob7Urk1@hDN&C$N!Nio9YrkiUC{5qA`KH*7CriaB;2~2Od>2l=WytBRl#~j`EYsj}jqK2xD*3 ztEUiPZzEJC??#Tj^?f)=sRXOJ_>5aO(|V#Yqro05p6)F$j5*wYr1zz|T4qz$0K(5! zr`6Pqd+)%a9Xq3aNKrY9843)O56F%=j_Yy_;|w8l&RU1+B4;pP*O_}X8!qD?IMiyT zLXBOOPg<*BZtT4LJ7DfyghK|_*mMP7a1>zS{8>?}#_XXaLoUBAz(Wi>$Q!L;oQ&cL z6O|T6%Dxq3E35$0g5areq9$2+R(911!Z9=wRPq-pju7DnN9LAfOu3%&onnfx^Px5( zT2^sU>Y)88F5#ATiVoS$jzC-M`vY8!{8#9O#3c&{7J1lo-rcNK7rlF0Zt*AKE(WN* z*o?Tv?Sdz<1v6gfCok8MG6Pzecx9?C zrQG5j^2{V556Hj=xTiU-seOCr2ni@b<&!j>GyHbv!&uBbHjH-U5Ai-UuXx0lcz$D7%=! z&zXD#Jqzro@R=hy8bv>D_CaOdqo6)vFjZldma5D+R;-)y1NGOFYqEr?h zd_mTwQ@K2veZTxh1aaV4F;YnaWA~|<8$p}-eFHashbWW6Dzj=3L=j-C5Ta`w-=QTw zA*k9!Ua~-?eC{Jc)xa;PzkUJ#$NfGJOfbiV^1au;`_Y8|{eJ(~W9pP9q?gLl5E6|e{xkT@s|Ac;yk01+twk_3nuk|lRu{7-zOjLAGe!)j?g+@-;wC_=NPIhk(W zfEpQrdRy z^Q$YBs%>$=So>PAMkrm%yc28YPi%&%=c!<}a=)sVCM51j+x#<2wz?2l&UGHhOv-iu z64x*^E1$55$wZou`E=qjP1MYz0xErcpMiNYM4+Qnb+V4MbM;*7vM_Yp^uXUuf`}-* z_2CnbQ);j5;Rz?7q)@cGmwE^P>4_u9;K|BFlOz_|c^1n~%>!uO#nA?5o4A>XLO{X2 z=8M%*n=IdnXQ}^+`DXRKM;3juVrXdgv79;E=ovQa^?d7wuw~nbu%%lsjUugE8HJ9zvZIM^nWvjLc-HKc2 zbj{paA}ub~4N4Vw5oY{wyop9SqPbWRq=i@Tbce`r?6e`?`iOoOF;~pRyJlKcIJf~G z)=BF$B>YF9>qV#dK^Ie#{0X(QPnOuu((_-u?(mxB7c9;LSS-DYJ8Wm4gz1&DPQ8;0 z=Wao(zb1RHXjwbu_Zv<=9njK28sS}WssjOL!3-E5>d17Lfnq0V$+IU84N z-4i$~!$V-%Ik;`Z3MOqYZdiZ^3nqqzIjLE+zpfQC+LlomQu-uNCStj%MsH(hsimN# z%l4vpJBs_2t7C)x@6*-k_2v0FOk<1nIRO3F{E?2DnS}w> z#%9Oa{`RB5FL5pKLkg59#x~)&I7GzfhiVC@LVFSmxZuiRUPVW*&2ToCGST0K`kRK) z02#c8W{o)w1|*YmjGSUO?`}ukX*rHIqGtFH#!5d1Jd}&%4Kc~Vz`S7_M;wtM|6PgI zNb-Dy-GI%dr3G3J?_yBX#NevuYzZgzZ!vN>$-aWOGXqX!3qzCIOzvA5PLC6GLIo|8 zQP^c)?NS29hPmk5WEP>cHV!6>u-2rR!tit#F6`_;%4{q^6){_CHGhvAs=1X8Fok+l zt&mk>{4ARXVvE-{^tCO?inl{)o}8(48az1o=+Y^r*AIe%0|{D_5_e>nUu`S%zR6|1 zu0$ov7c`pQEKr0sIIdm7hm{4K_s0V%M-_Mh;^A0*=$V9G1&lzvN9(98PEo=Zh$`Vj zXh?fZ;9$d!6sJRSjTkOhb7@jgSV^2MOgU^s2Z|w*e*@;4h?A8?;v8JaLPCoKP_1l- z=Jp0PYDf(d2Z`;O7mb6(_X_~z0O2yq?H`^c=h|8%gfywg#}wIyv&_uW{-e8e)YmGR zI0NNSDoJWa%0ztGzkwl>IYW*DesPRY?oH+ow^(>(47XUm^F`fAa0B~ja-ae$e>4-A z64lb_;|W0ppKI+ zxu2VLZzv4?Mr~mi?WlS-1L4a^5k+qb5#C)ktAYGUE1H?Vbg9qsRDHAvwJUN=w~AuT zUXYioFg2Dx-W)}w9VdFK#vpjoSc!WcvRZ_;TgHu;LSY*i7K_>Px{%C4-IL?6q?Qa_ zL7l=EEo|@X&$gX;fYP02qJF~LN9?E-OL2G(Fo4hW)G{`qnW zTIuc+-1VJvKgph0jAc(LzM);Pg$MPln?U|ek{_5nNJHfm-Y#ec+n#Yf_e>XfbLbN)eqHEDr0#?<;TskL5-0JGv|Ut{=$Xk8hlwbaMXdcI3GL zY-hykR{zX9liy$Z2F3!z346uu%9@-y6Gda`X2*ixlD_P@<}K?AoV?(%lM%* z(xNk=|A()443aGj)-~IDf3J+UA2p2lh6ei^pG*HL#SiThnIr5WZDXebI)F7X zGmP-3bH$i$+(IwqgbM7h%G5oJ@4{Z~qZ#Zs*k7eXJIqg;@0kAGV|b=F#hZs)2BYu1 zr8sj#Zd+Iu^G}|@-dR5S*U-;DqzkX3V0@q-k8&VHW?h0b0?tJ-Atqmg^J8iF7DP6k z)W{g?5~F*$5x?6W)3YKcrNu8%%(DglnzMx5rsU{#AD+WPpRBf``*<8F-x75D$$13U zcaNXYC0|;r&(F@!+E=%+;bFKwKAB$?6R%E_QG5Yn5xX#h+zeI-=mdXD5+D+lEuM`M ze+*G!zX^xbnA?~LnPI=D2`825Ax8rM()i*{G0gcV5MATV?<7mh+HDA7-f6nc@95st zzC_si${|&=$MUj@nLxl_HwEXb2PDH+V?vg zA^DJ%dn069O9TNK-jV}cQKh|$L4&Uh`?(z$}#d+{X zm&=KTJ$+KvLZv-1GaHJm{>v=zXW%NSDr8$0kSQx(DQ)6S?%sWSHUazXSEg_g3agt2@0nyD?A?B%9NYr(~CYX^&U#B4XwCg{%YMYo%e68HVJ7`9KR`mE*Wl7&5t71*R3F>*&hVIaZXaI;2a$?;{Ew{e3Hr1* zbf$&Fyhnrq7^hNC+0#%}n^U2{ma&eS)7cWH$bA@)m59rXlh96piJu@lcKl<>+!1#s zW#6L5Ov%lS(?d66-(n`A%UuiIqs|J|Ulq0RYq-m&RR0>wfA1?<34tI?MBI#a8lY{m z{F2m|A@=`DpZpwdIH#4)9$#H3zr4kn2OX!UE=r8FEUFAwq6VB?DJ8h59z$GXud$#+ zjneIq8uSi&rnG0IR8}UEn5OcZC?@-;$&Ry9hG{-1ta`8aAcOe1|82R7EH`$Qd3sf* zbrOk@G%H7R`j;hOosRVIP_2_-TuyB@rdj?(+k-qQwnhV3niH+CMl>ELX(;X3VzZVJ ztRais0C^L*lmaE(nmhvep+peCqr!#|F?iVagZcL>NKvMS_=*Yl%*OASDl3(mMOY9! z=_J$@nWpA-@><43m4olSQV8(PwhsO@+7#qs@0*1fDj70^UfQ(ORV0N?H{ceLX4<43 zEn)3CGoF&b{t2hbIz;Og+$+WiGf+x5mdWASEWIA*HQ9K9a?-Pf9f1gO6LanVTls)t z^f6_SD|>2Kx8mdQuiJwc_SmZOZP|wD7(_ti#0u=io|w~gq*Odv>@8JBblRCzMKK_4 zM-uO0Ud9>VD>J;zZzueo#+jbS7k#?W%`AF1@ZPI&q%}beZ|ThISf-ly)}HsCS~b^g zktgqOZ@~}1h&x50UQD~!xsW-$K~whDQNntLW=$oZDClUJeSr2$r3}94Wk1>co3beS zoY-7t{rGv|6T?5PNkY zj*XjF()ybvnVz5=BFnLO=+1*jG>E7F%&vm6up*QgyNcJJPD|pHoZ!H6?o3Eig0>-! zt^i-H@bJ;^!$6ZSH}@quF#RO)j>7A5kq4e+7gK=@g;POXcGV28Zv$jybL1J`g@wC# z_DW1ck}3+n@h2LFQhwVfaV@D+-kff4celZC0;0ef?pA#*PPd8Kk8sO1wza&BHQFblVU8P1=-qScHff^^fR zycH!hlHQs7iejITpc4UaBxzqTJ}Z#^lk{W(cr`qtW~Ap;HvuUf#MxgEG?tEU+B?G% znub0I(s@XvI(lva}$Z7<}Qg=rWd5n)}rX{nb+Aw;}?l9LZI-`N-*hts=c6XgjfJs ztp>-686v6ug{glEZ}K=jVG|N1WSWrU*&ue|4Q|O@;s0#L5P*U%Vx;)w7S0ZmLuvwA z@zs2Kut)n1K7qaywO#TbBR`Q~%mdr`V)D`|gN0!07C1!r3{+!PYf9*;h?;dE@#z(k z;o`g~<>P|Sy$ldHTUR3v=_X0Iw6F>3GllrFXVW?gU0q6|ocjd!glA)#f0G7i20ly>qxRljgfO2)RVpvmg#BSrN)GbGsrIb}9 z1t+r;Q>?MGLk#LI5*vR*C8?McB|=AoAjuDk&Pn`KQo z`!|mi{Cz@BGJ!TwMUUTkKXKNtS#OVNxfFI_Gfq3Kpw0`2AsJv9PZPq9x?~kNNR9BR zw#2jp%;FJNoOzW>tE#zskPICp>XSs?|B0E%DaJH)rtLA}$Y>?P+vEOvr#8=pylh zch;H3J`RE1{97O+1(1msdshZx$it^VfM$`-Gw>%NN`K|Tr$0}U`J?EBgR%bg=;et0 z_en)!x`~3so^V9-jffh3G*8Iy6sUq=uFq%=OkYvHaL~#3jHtr4sGM?&uY&U8N1G}QTMdqBM)#oLTLdKYOdOY%{5#Tgy$7QA! zWQmP!Wny$3YEm#Lt8TA^CUlTa{Cpp=x<{9W$A9fyKD0ApHfl__Dz4!HVVt(kseNzV z5Fb`|7Mo>YDTJ>g;7_MOpRi?kl>n(ydAf7~`Y6wBVEaxqK;l;}6x8(SD7}Tdhe2SR zncsdn&`eI}u}@^~_9(0^r!^wuKTKbs-MYjXy#-_#?F=@T*vUG@p4X+l^SgwF>TM}d zr2Ree{TP5x@ZtVcWd3++o|1`BCFK(ja-QP?zj6=ZOq)xf$CfSv{v;jCcNt4{r8f+m zz#dP|-~weHla%rsyYhB_&LHkwuj83RuCO0p;wyXsxW5o6{)zFAC~2%&NL? z=mA}szjHKsVSSnH#hM|C%;r0D$7)T`HQ1K5vZGOyUbgXjxD%4xbs$DAEz)-;iO?3& zXcyU*Z8zm?pP}w&9ot_5I;x#jIn^Joi5jBDOBP1)+p@G1U)pL6;SIO>Nhw?9St2UN zMedM(m(T6bNcPPD`%|9dvXAB&IS=W4?*7-tqldqALH=*UapL!4`2TM_{`W&pm*{?| z0DcsaTdGA%RN={Ikvaa&6p=Ux5ycM){F1OgOh(^Yk-T}a5zHH|=%Jk)S^vv9dY~`x zG+!=lsDjp!D}7o94RSQ-o_g#^CnBJlJ@?saH&+j0P+o=eKqrIApyR7ttQu*0 z1f;xPyH2--)F9uP2#Mw}OQhOFqXF#)W#BAxGP8?an<=JBiokg;21gKG_G8X!&Hv;7 zP9Vpzm#@;^-lf=6POs>UrGm-F>-! zm;3qp!Uw?VuXW~*Fw@LC)M%cvbe9!F(Oa^Y6~mb=8%$lg=?a0KcGtC$5y?`L5}*-j z7KcU8WT>2PpKx<58`m((l9^aYa3uP{PMb)nvu zgt;ia9=ZofxkrW7TfSrQf4(2juZRBgcE1m;WF{v1Fbm}zqsK^>sj=yN(x}v9#_{+C zR4r7abT2cS%Wz$RVt!wp;9U7FEW&>T>YAjpIm6ZSM4Q<{Gy+aN`Vb2_#Q5g@62uR_>II@eiHaay+JU$J=#>DY9jX*2A=&y8G%b zIY6gcJ@q)uWU^mSK$Q}?#Arq;HfChnkAOZ6^002J>fjPyPGz^D5p}o;h2VLNTI{HGg!obo3K!*I~a7)p-2Z3hCV_hnY?|6i`29b zoszLpkmch$mJeupLbt4_u-<3k;VivU+ww)a^ekoIRj4IW4S z{z%4_dfc&HAtm(o`d{CZ^AAIE5XCMvwQSlkzx3cLi?`4q8;iFTzuBAddTSWjfcZp* zn{@Am!pl&fv#k|kj86e$2%NK1G4kU=E~z9L^`@%2<%Dx%1TKk_hb-K>tq8A9bCDfW z@;Dc3KqLafkhN6414^46Hl8Tcv1+$q_sYjj%oHz)bsoGLEY1)ia5p=#eii(5AM|TW zA8=;pt?+U~>`|J(B85BKE0cB4n> zWrgZ)Rbu}^A=_oz65LfebZ(1xMjcj_g~eeoj74-Ex@v-q9`Q{J;M!mITVEfk6cn!u zn;Mj8C&3^8Kn%<`Di^~Y%Z$0pb`Q3TA}$TiOnRd`P1XM=>5)JN9tyf4O_z}-cN|i> zwpp9g`n%~CEa!;)nW@WUkF&<|wcWqfL35A}<`YRxV~$IpHnPQs2?+Fg3)wOHqqAA* zPv<6F6s)c^o%@YqS%P{tB%(Lxm`hsKv-Hb}MM3=U|HFgh8R-|-K(3m(eU$L@sg=uW zB$vAK`@>E`iM_rSo;Cr*?&wss@UXi19B9*0m3t3q^<)>L%4j(F85Ql$i^;{3UIP0c z*BFId*_mb>SC)d#(WM1%I}YiKoleKqQswkdhRt9%_dAnDaKM4IEJ|QK&BnQ@D;i-ame%MR5XbAfE0K1pcxt z{B5_&OhL2cx9@Sso@u2T56tE0KC`f4IXd_R3ymMZ%-!e^d}v`J?XC{nv1mAbaNJX| zXau+s`-`vAuf+&yi2bsd5%xdqyi&9o;h&fcO+W|XsKRFOD+pQw-p^pnwwYGu=hF7& z{cZj$O5I)4B1-dEuG*tU7wgYxNEhqAxH?p4Y1Naiu8Lt>FD%AxJ811`W5bveUp%*e z9H+S}!nLI;j$<*Dn~I*_H`zM^j;!rYf!Xf#X;UJW<0gic?y>NoFw}lBB6f#rl%t?k zm~}eCw{NR_%aosL*t$bmlf$u|U2hJ*_rTcTwgoi_N=wDhpimYnf5j!bj0lQ*Go`F& z6Wg+xRv55a(|?sCjOIshTEgM}2`dN-yV>)Wf$J58>lNVhjRagGZw?U9#2p!B5C3~Nc%S>p`H4PK z7vX@|Uo^*F4GXiFnMf4gwHB;Uk8X4TaLX4A>B&L?mw4&`XBnLCBrK2FYJLrA{*))0 z$*~X?2^Q0KS?Yp##T#ohH1B)y4P+rR7Ut^7(kCwS8QqgjP!aJ89dbv^XBbLhTO|=A z|3FNkH1{2Nh*j{p-58N=KA#6ZS}Ir&QWV0CU)a~{P%yhd-!ehF&~gkMh&Slo9gAT+ zM_&3ms;1Um8Uy0S|0r{{8xCB&Tg{@xotF!nU=YOpug~QlZRKR{DHGDuk(l{)d$1VD zj)3zgPeP%wb@6%$zYbD;Uhvy4(D|u{Q_R=fC+9z#sJ|I<$&j$|kkJiY?AY$ik9_|% z?Z;gOQG5I%{2{-*)Bk|Tia8n>TbrmjnK+8u*_cS%*;%>R|K|?urtIdgTM{&}Yn1;| zk`xq*Bn5HP5a`ANv`B$IKaqA4e-XC`sRn3Z{h!hN0=?x(kTP+fE1}-<3eL+QDFXN- z1JmcDt0|7lZN8sh^=$e;P*8;^33pN>?S7C0BqS)ow4{6ODm~%3018M6P^b~(Gos!k z2AYScAdQf36C)D`w&p}V89Lh1s88Dw@zd27Rv0iE7k#|U4jWDqoUP;-He5cd4V7Ql)4S+t>u9W;R-8#aee-Ct1{fPD+jv&zV(L&k z)!65@R->DB?K6Aml57?psj5r;%w9Vc3?zzGs&kTA>J9CmtMp^Wm#1a@cCG!L46h-j z8ZUL4#HSfW;2DHyGD|cXHNARk*{ql-J2W`9DMxzI0V*($9{tr|O3c;^)V4jwp^RvW z2wzIi`B8cYISb;V5lK}@xtm3NB;88)Kn}2fCH(WRH1l@3XaO7{R*Lc7{ZN1m+#&diI7_qzE z?BS+v<)xVMwt{IJ4yS2Q4(77II<>kqm$Jc3yWL42^gG6^Idg+y3)q$-(m2>E49-fV zyvsCzJ5EM4hyz1r#cOh5vgrzNGCBS}(Bupe`v6z{e z)cP*a8VCbRuhPp%BUwIRvj-$`3vrbp;V3wmAUt{?F z0OO?Mw`AS?y@>w%(pBO=0lohnxFWx`>Hs}V$j{XI2?}BtlvIl7!ZMZukDF7 z^6Rq2H*36KHxJ1xWm5uTy@%7;N0+|<>Up>MmxKhb;WbH1+=S94nOS-qN(IKDIw-yr zi`Ll^h%+%k`Yw?o3Z|ObJWtfO|AvPOc96m5AIw;4;USG|6jQKr#QP}+BLy*5%pnG2 zyN@VMHkD`(66oJ!GvsiA`UP;0kTmUST4|P>jTRfbf&Wii8~a`wMwVZoJ@waA{(t(V zwoc9l*4F>YUM8!aE1{?%{P4IM=;NUF|8YkmG0^Y_jTJtKClDV3D3~P7NSm7BO^r7& zWn!YrNc-ryEvhN$$!P%l$Y_P$s8E>cdAe3=@!Igo^0diL6`y}enr`+mQD;RC?w zb8}gXT!aC`%rdxx2_!`Qps&&w4i0F95>;6;NQ-ys;?j#Gt~HXzG^6j=Pv{3l1x{0( z4~&GNUEbH=9_^f@%o&BADqxb54EAq=8rKA~4~A!iDp9%eFHeA1L!Bb8Lz#kF(p#)X zn`CglEJ(+tr=h4bIIHlLkxP>exGw~{Oe3@L^zA)|Vx~2yNuPKtF^cV6X^5lw8hU*b zK-w6x4l&YWVB%0SmN{O|!`Sh6H45!7}oYPOc+a#a|n3f%G@eO)N>W!C|!FNXV3taFdpEK*A1TFGcRK zV$>xN%??ii7jx5D69O>W6O`$M)iQU7o!TPG*+>v6{TWI@p)Yg$;8+WyE9DVBMB=vnONSQ6k1v z;u&C4wZ_C`J-M0MV&MpOHuVWbq)2LZGR0&@A!4fZwTM^i;GaN?xA%0)q*g(F0PIB( zwGrCC#}vtILC_irDXI5{vuVO-(`&lf2Q4MvmXuU8G0+oVvzZp0Y)zf}Co0D+mUEZz zgwR+5y!d(V>s1} zji+mrd_6KG;$@Le2Ic&am6O+Rk1+QS?urB4$FQNyg2%9t%!*S5Ts{8j*&(H1+W;0~ z$frd%jJjlV;>bXD7!a-&!n52H^6Yp}2h3&v=}xyi>EXXZDtOIq@@&ljEJG{D`7Bjr zaibxip6B6Mf3t#-*Tn7p z96yx1Qv-&r3)4vg`)V~f8>>1_?E4&$bR~uR;$Nz=@U(-vyap|Jx zZ;6Ed+b#GXN+gN@ICTHx{=c@J|97TIPWs(_kjEIwZFHfc!rl8Ep-ZALBEZEr3^R-( z7ER1YXOgZ)&_=`WeHfWsWyzzF&a;AwTqzg~m1lOEJ0Su=C2<{pjK;{d#;E zr2~LgXN?ol2ua5Y*1)`(be0tpiFpKbRG+IK(`N?mIgdd9&e6vxzqxzaa`e7zKa3D_ zHi+c1`|720|dn(z4Qos^e7sn(PU%NYLv$&!|4kEse%DK;YAD06@XO3!EpKpz!^*?(?-Ip zC_Zlb(-_as+-D?0Ag9`|4?)bN)5o(J=&udAY|YgV(YuK9k=E>0z`$dSaL(wmxd!1f zME&3wwv@#{dgeMlZ4}GL!I`VZxtdQY$lmauCN_|mGXqEEj@i~du$|>5UvLjsbq!{; z@jEf;21iC1jFEmIPE^4gykHQzCMLj=2Ek4&FvlpqTlS(0YT%*W<>XgH$4ww`D`aihBGkPM(&EG};Cl&wzg8!jL z`rkqPzvH(0Kd{2n=?Bt8aAU&0IyiA+V-qnXVId^qG!SWZ7%_f&i!D{R#7Jo$%tICxY%j)ebORE>3H_c|to}c#HX;HAC?~B;2mmQrMp2;8T zmzde!k7BYg^Z1r|DUvSD3@{6S<1kndb%Qt%GA# z+sB2&F5L`R&fLRdAlpU_pVsJsYDEz{^ zKGaAz#%W+MPGT+D$+xowMY0=ipM)0p?zym&Aoi)qL(pO_weO(k?s|ELHl^W zviJiFUXRL&?`;3_;mvc02A@sbsW9}#{anvGafZ#ST;}za?XS3}ZG3B4m(SW{>w}Fh z)T5Yi*``Tstmi9SHXmuWSND@cj}qtY!`tuD29Dpu+-D3$h<5FY>jE>YJvqBmhw?oll`x7Ono(}R~P zle_eBwYy0Rr7kmf_SEt_gn4)AO-r`}^Z5Y%Rm8)K-?X>rvDL+QT?#)QwDsQ2c$tc* z&#hbgkL6}GnBDH;+lREM6MGIskRa@r>5Iq(ll2IepuhW86w@14=E{6$cz*cBDQ)CT>}v-DLM-v8)xaPBnmGBKM63RgDGqh!<*j90tSE4|G^+r@#-7g2 zs8KE8eZPZhQuN>wBU%8CmkE9LH1%O;-*ty0&K~01>F3XB>6sAm*m3535)9T&Fz}A4 zwGjZYVea@Fesd=Rv?ROE#q=}yfvQEP8*4zoEw4@^Qvw54utUfaR1T6gLmq?c9sON> z>Np6|0hdP_VURy81;`8{ZYS)EpU9-3;huFq)N3r{yP1ZBCHH7=b?Ig6OFK~%!GwtQ z3`RLKe8O&%^V`x=J4%^Oqg4ZN9rW`UQN^rslcr_Utzd-@u-Sm{rphS-y}{k41)Y4E zfzu}IC=J0JmRCV6a3E38nWl1G495grsDDc^H0Fn%^E0FZ=CSHB4iG<6jW1dY`2gUr zF>nB!y@2%rouAUe9m0VQIg$KtA~k^(f{C*Af_tOl=>vz>$>7qh+fPrSD0YVUnTt)? z;@1E0a*#AT{?oUs#bol@SPm0U5g<`AEF^=b-~&4Er)MsNnPsLb^;fL2kwp|$dwiE3 zNc5VDOQ%Q8j*d5vY##)PGXx51s8`0}2_X9u&r(k?s7|AgtW0LYbtlh!KJ;C9QZuz< zq>??uxAI1YP|JpN$+{X=97Cdu^mkwlB={`aUp+Uyu1P139=t%pSVKo7ZGi_v(0z>l zHLGxV%0w&#xvev)KCQ{7GC$nc3H?1VOsYGgjTK;Px(;o0`lerxB<+EJX9G9f8b+)VJdm(Ia)xjD&5ZL45Np?9 zB%oU;z05XN7zt{Q!#R~gcV^5~Y^gn+Lbad7C{UDX2Nznj8e{)TLH|zEc|{a#idm@z z6(zon+{a>FopmQsCXIs*4-dLGgTc)iOhO3r=l?imNUR-pWl!ktO0r_a0Nqo@bu8MzyjSq9zkqPe*`Sxz75rZ zr9X%(=PVqCRB=zfX+_u&*k4#s1k4OV11YgkCrlr6V;vz<{99HKC@qQ+H8xv5)sc63 z69;U4O&{fb5(fN``jJH#3=GHsV56@{d@7`VhA$K^;GU+R-V%%cnmjYs?>c5^6Ugv} zn<}L&i;2`zzW@(kxf$$gVH@7nh}2%G%ciQ_B?r{13?Q@=Q+6msQGtnyY%Gkjeor?g z7F*tMqLdhcq+LCCo^D;CtOACCBhXgK-M&w{*dcUdmtv@XFTofmmpcWKtCn^`#?oZC zUOm52 z7sK$hR|Vh6y&pfIUK&!`8HH*>12$nWA)Ynp+XwOj=jNLD z{QA4gezbe>wiP?`jJO;c&EId;=2u80s_r97;TX!6@*(<%WL+^bmxheMB3pKx0OpH^ zPs}knV+jpJ4TaD@r^V`mTsjf`7!z^H}eHQ#Rp z72(>Dm#QO!ZYR*O@yHic`3*T^t7jc=d`Jz6Lk@Y-bL%cOp_~=#xzIJl?`{Qu;$uC~NkePE+7wSW_FM`&V{gFN zl;lq@;FtAsl!h;tnOvj z#gYx!q$5MdZ0Jxjy=t*q)HFeeyI-vgaGdh1QNhqGRy8qS)|6S0QK7Gj9R?Co{Knh> za>xkQZ0}bBx!9@EUxRBYGm25^G}&j-`0VWX04E|J!kJ8^WoZ(jbhU_twFwWIH32fv zi=pg~(b#ajW=`)Vikwwe39lpML?|sY$?*6*kYBxku_<=#$gfTqQ_F!9F0=OkHnzBo zEwR!H_h|MNjuG$Tj6zaaouO}HYWCF8vN4C%EX-%Iu%ho;q$G#ErnafhXR*4J2Rp5* zhsi0;wlSwE*inVFO>{(8?N~82zijpt+9Y_-^>xnE%T*zk9gi|j7b@s<5{|qEquUD( zS;-%RySZOCOEh*>!kvbsQ265* z>X8*_Wy&~FB@aDHz%glyiAujXq-|2kDUjFTn9Rafsl+XNyFP%PG|l&ZGWBcEXxy=9 zeDn2PIoVuL$gX0RgVK1O$x3%pOzS7x^U5Pi;mtT)%cY;&e&M7GLM}zP+IPbqLt=^5 z7qLfri8myf;~2psc@^cA6mG&{C%e_(M$$!wC^5p^T1QzrS%I?(U{qcd+oJJkQxe10 zON{Q*?iz%F4MbEsoEc+x3E?&2wVR^v3|Q0lDaMvgS7mNjI{2w! z9|~=!83T%GW*iaChSS!`Xd^beFp9N4%K+k*j#jFumk}U?=WKL_kJAltxnxp~+lZzT zp@&&kSPTg3oSGos`rVBhK0|4NdHM_hnKuw1#0JV{gi_dKDJLB+ix~~HpU9%jD)@YY zOK)L7kgbLyN2%Dx#fuY}8swh4ACk7%BpP-n5(RhDq{gEHP*Fo4IviX{C49|B5h~SC zFr`=0)=h2^F5UpCAgt?R5u{6VvpUf#*nC zCQ`$!|C;L2lpjlG?(>T$(_$O3_YNNbPT~(?!j3aD8k=yu^ogw4bkjvgF|3BOq(hB& zG;^cPXmcUP$ox8zElCJ-zMbK9q^8{rri#8Cek5Ydr0YT-KTh@J z6^AcB9ejew8BY5kzZUZX(7Po==eW<(;uV~E7(BY5c0^xr`cuRwn)47bN?zOb!0?cw z#v}R$z66&m#+AHfo@(^V2#S~bhoUkkTArg+6w>JzZ52r96^({1W!?>4$h0l|-jDfj z>7(<+%67#(A|4hZ3>Y;hd&S?}F;`Vtqz|pK&B>NJ=Faci;gkf-+GmfQR8^zo_vul2 zB!)kfu4Dq_g)8TBBo52*sB6F`qa&JCR=_A$QWgX_K}fZm{Cb2#1q`^S3+WaS>sS#@ z-4k*G=#?z6d_e7JJ+Z8^(t0tNdL{K5F;2nfQbXgld}a(X)Gr;WojOy`^?es~AClT$ z5^lD{WJek0!p-QEH5E7n6DKQ0%_ZBZ=|jfV_MM{VmL8y-Wd|>OmeemP=C@xI@@M~1 zW2S*im@Rc=O>V886_UJ@oh1!2H$Ku&U*Hh_oxd{32)vf1$cRiepv28ricM;}#p!+k zaK{z1I=9Y%3m4|Pj*BD*Fn5Vh?O@oD^1UcjyeNh0fbhh~V6xb#4njlGW8OehUe!MnoR(wn#nsoyL1m!Rov)Nv4~&JEVl7L z#^qYdTpNI#u`N0UbVMiDmD>g2VQcG3>4D6gErgddZnSQTs){BExxRJRB?bIxTdZa z;!S8FHJPPiIDQ*FAUiWSYnjILFjDvxvSC zk z=j4Kx@Pg~&2Z?cmMDa;)#xVeorJrxDBqy{+`kG+ZPQqC@#ku-c3ucU+69$#q_*se` z-H#PFW^>-C0>++|6r=<$Z8)ZFaK=ZjwsNYXqRpl9G|yme@Eld5B-*I69Nx_TResHi z!5nm+>6zaJYQO#%D{~o-oOJ;q`fa5}l!8G*U-E$OM&7@dqciBCWtd}|SrDXz$TB($&m*=Epuolu2k`KUwO7maP3P0ok zmF57lSh0Ba@&sO1iZ5^+3s8{B8t|M;Pg&O+{tZJCiLWd6H@{b~9{CLF9s3Kn zt5)Rs9ejne?o{%f>B$Dl%X7fd~KY)I|(pxUeHj;gNsK6;ZR>`ciu;GxvhDUt!+31Knss2U(%ts8K z18)8;<2ax9RG?!|Lwdt^i5L^&O788roKmVAB)=EdK~HqR2Q=)H_VW}xY=95MP_Ov< zPEz3%DRK}+(aUBwsr83H8>`H^v~|A_t}0vPmRwKPt1{|qOY|PZu}j9+{ZhF&-H_TB zU9xWLpNTc`enI|)h9jQeqf5RfGLFk_vfX`40iMpd%KZF!lKbZTdBw$<^G6nuS+$fT zrbK)xo&;buPJcpOZ=x>n+bRXVFDs(23Xr=rDE&!)pVXZ;;A07NXGl_0m`{Z)DQIu$ zFDvY4xu-ifTe_$|n2B83eI;KUg6pVbw+N!nyLj~wnRi{4mNy{WDV)G1!6$y=+x6U{ z%4_9=Q^L!x_gAYp?J3+u5hA5cO8aHeI=6AC8^S{mzhqCBvBLYEutUC(X0>hKg|AvN zvkmJCQNA45_KjW{aEcyrBppcO6G0zTy%v1&@~+2!n?kA9?>0>AjFN|JdCnHQ8$hEU zw#mwGifHppLP?89LMb(Y3Li9iCPx7W%ek}2FgD2YSzjsR4Xj<=zN{Yo@7s7(k%mP4 znT2p&4EQ@q_chd-E z78uvD*C@oba`U3W2Iw`M#`5C8jOHv8^Li<|j^SI>>>`77Dp71Vtz=J?4Zck4SdRbd zfF}C_>Y(#)r@y!Q0`tMlG#b9>5`fAI$B&tWJfbGlYW$J4V+-s=HH!`+;1XeL@USdx zR0$G&&XBf9lQtkH5)p=U!8J!1{oc4E!N-~Abxl6E;;=3-hMYZ+44?u}zabmCE)yB?*_w91m$n1Yskp&@ z;kxeJX-#ioX^{elyLu~gzx|_KxLpX62MF%Axq3$!Z_P`pBWR?zP8OI`PV~6Aa0Oi0 zv_Ot1m&plf-ZF{e(z(Ms3*S5q$e|j;gOwGrmWsCHfLi(h8y?gc$(2H{884C1FvHQQ12tX=qFUsK~zM!W=K>;zaRsu4Xmcc@8nSs!vK+{ z?}bq}-m&p5jRSam67n>yG9ez=I^|J1O;Np8s=P~9MXYLxD+cFQK7PhG=bkjo{Naae zjp3NWWrlFWDb3Z5D07Q|WjZ=wOQ=aKA%en=O@hL$QCKpIXNZE=InFk|Fhq-&H!6&X z*MVy8=hL7Aw&pQjHrFf27C%3B<>FX{@fOLNhUoxL4*@nY}&M3G*T-p67a zo}~_&yGOB)#vbU|Q3FA8S^X)c-yBlmN(_%}`7Ha3uWFe?>9f=3hlO{^gv~$p`v?vk z_P*r43|(S{%ihs;)YH|jAMpP=-Ms7Ne75_YZZiL3CHVjSU`X1|?Ehh&gA=Xn7W7d@ zf8bM9Y>lG!`PWFDDA9G;x*{1Eh^55u66*9D+-4^dYZ{xXP@?sQLVrY%(azM;C^4FuN7CQ%$!3sr1JL=!Be& zuOZL^bLp$Qo2rL=WDzQIls%s!Go z{s}Q0b#+#8bKga|01t%^9Z=wEsevvXM_{$dCR97ed3@1kX)mtSS!JN^rtqKOj}p~> zfpCI@DX*DqcB6ZnBcl~}sGO~1s$AtfkX6fy3N8*ebvZc*KBW;dA=)?#BE&}-or74i zZUt5;{FBPnkZD8YUXDsx&2LvSziAlec3oc>&Lf1Doc3g?H9{OO_$M4B0qTat0UsWP zTlxUeQ3B;oJ%en4n?zQB6*Fb#wH7`$SQN5GI|=DnJKiYm{?-?#-H;#sIjz7kQ4&VW zN9d1(1$_W~S=<%qDD!mwRytas=eqX^iW}YSx3;wJ#)Xp_`Qk1DFiXac$-3;jQbCif zLA-T_s~5yP@Q@W>pXKl^gipQ>gp@HlBB>WDVpW199;V%?N1`U$ovLE;NI2?|_q2~5 zlg>xT9NADWkv5-*FjS~nP^7$k!N2z?dr!)&l0+4xDK7=-6Rkd$+_^`{bVx!5LgC#N z-dv-k@OlYCEvBfcr1*RsNwcV?QT0bm(q-IyJJ$hm2~mq{6zIn!D20k5)fe(+iM6DJ ze-w_*F|c%@)HREgpRrl@W5;_J5vB4c?UW8~%o0)(A4`%-yNk1(H z5CGuzH(uHQ`&j+IRmTOKoJ?#Ct$+1grR|IitpDGt!~ZdqSJ?cOtw-R=EQ+q4UvclH zdX=xlK-fhQKoKCPBoFAZ*(~11O6-tXo>i0w!T$u{lg!#itEUX3V{$S*naW!C@%rll zS{L(1t%xz(*B`{1NL!*aMc<~fE=g;gXi&Gb$HpD!P)8?JzfN;4F&wv(5HH<=c>>)n z({271)xREH89=C(5YKL{mmJJ_d>qHz;;gTvTlgM*vz9@YTTYZ#%_2A zS0G-t9oMQEpvfv(UjfQ8T$vAHi)zOj3>D*{xSRiu3acc=7cvLyD?_ZObdu$5@b*!y zaZ#u?7uF}SrHVQa=sTOhGW{6WUlq#RhPPm^GsRH#qlX8{Kq-i~98l;eq>KdCnWyKl zUu&UWBqu#Tt9jQ97U4}3)&(p2-eCLznXMEm!>i^EMpeVzPg%p;?@O;dJBQQY(vV;d z3v+-3oTPC!2LTUAx^S2t{v;S_h(EZ^0_dS5g^F*m{TEIy^Qal~%mu3h7*o`jWOH}i ztv8M)3X3a*+ry_KkYXYE4dB0?M|t}#Tp+(}6CQ zBbq;xhoHj}b@j-@koDB#XcCY~>_x&Y;i%MH|3tF^X2h{36UCVfQ-;oEA+4ZkJ`^Qi zQf^8}6eFO$Z+Dj-F1wkG##tTx>FjR2oOXFmbKFj6K3+=kePQ<4d7%z5R5cOB;zO6| zm9^m#U4lcA;7t&*=q|a-!`!)}SgYXT#i8hnxtx@kaoBF$QAS-hT7N5kH^l zB^i+})V>L;9_0Qqf-dyF%ky8Mp-dp#%!Nls3vCt}q3QLM3M-(Zs1k}1bqQ9PVU)U` ztE=?;^6=x}_VD%N@${>qhpkU*)AuUBu_cqYiY&@;O$HV*z@~#Tzh?#=CK`=KwBv+o zh%zu%0xPKYtyC)DaQ zpDW}*86g%>BH3IcWMq`g$j()0kWE(qkIL8A&A0mf&+BzxpKF}=`#jG% z&*wa!&pGFLs5_b#QTZE4Bp+})qzyPQ7B4Z7Y*&?0PSX&|FIR;WBP1|coF9ZeP*$9w z!6aJ_3%Sh=HY3FAt8V144|yfu}IAyYHr1OYKIZ51F>_uY^%N#!k~eU53at-_E-Gh?ahmM5y* z+BTIbeH;%v1}Cjo{8d%UeSMWg(nphxEU`sL< zQR~LrTq>Da(FqSP2%&^1ZL#DTo5Sbl9;&57tQ-@U&I#lj)aNSkcfEJwQD!33?anVU z?pw2q7WtMvfji493`rSFnyp7{w87cW`ak=UEYlk5PCB1K6UDVKXyozOChH4yHh~Q< zv>yvKw6WLfi!PZUx60JZcTNM7jo{ww9b8Q+S7C3WA5&llSwdwh$=Q(*(f3ofqcz=nwOmOy z(J!K=*wNoRU*${{Mbwapi9pTB(&VVKefqd-qrUb9*Eyr2E@oZ9Cgf}Mc;QP<0D)R4 zz=!*^VIG4T*7Xl=sJxrWv9hW^eJ%qYp5(d0?E6LZzJ}=7E+1{?GQA;z+!^VBD81}O z0kJ^dKy&WMw+1+aGVYY-v@i28@Gm+sX5=@U%F=Z?W)oar}2~Rc&F|+3A)n-U2GF10+QdxDb^iA@7eL$c7yhBtL z>lABrh^qy9XZ${E1}Ss5!N4;ig0-pUh6@|RPCHOWvgG{|l}2enRgJftsN%D|ck0YO zuAQd2aMPSyGuJ~jm)aY=+p~mGudw4erwE%P^)5f<*$$2C-4^I=e8-}7##ZQ!8!Tep z+Z_!}CAI~sry$|XK$ktXaxP*x<_ijCPp`2=6sNLZU<@9Sz-rz7^BCE9yh0jV4(I!Z zxmA4d;>B-!vD}Xp*&*N%`b^e&R;D97WS}{~{O-EtXeZNfdf51tw!WR6Noo4hjHPv5 z?heYYRSBPjMc}tFEU^|U8a1CxxK%)WTcn9P%`wR^I$QSeMn6=w>Z9OoVvcrl`zYlZ z2y`mAu0bV(Scc>G_EmIo_4 zm*~h`mxYZC&+U>C5G1FZH5L^U>Cq-9UDRQa35jz&NBj*0{uJKfZs5=Fn@&)Xh6aX(H3w9m9BGLePqVotxTeSPh5-mc7$# z-80t6yB0$Nx<54ohdO*QL7m_(&+#*=eoNiYDB4rE4Cag@qfyZS};Fx;Vf1;oync2k z9v#-w?d6R& zOI`CCS_d=tf3|?g3Z}b6-_Rdg3y~enQhmgkni0Cvf9m6%Ft8r;NC5|b%t&?lkl*4{ z8Ui^;Ds^gq6ti(1xB7y_$zA!i-M~#!!tl$ErTR>P~>T=Yky)8(uvPbvLmB=UfoD zrfl}8<1OQrm?8#j1!?s*T>AoectQl&m!o&*^JcIW`_&bk3tN}k^0rjl=HL$z*uIYt z?7l?^Dqr?q1210Sp$xoAy!&{2^{^Anl460 zI&7urrc&|Y{rjv04VOl{y7c82N6xzg5ueYmQ(q(zC3w_C#x*~%yf5j7MI{W`tsoxzA*PrmK)cTskU| zf2C}Bq$>S$-1JgIh0aW@LxI|-8(OGuD#^M01ghh}&#ObO>tZgSw_LW`zdf&IN$YO# z)|X_9m#JwLW5pErZB3ScggKcNzxA9(hyKkK9I#pR&79&*+SV_eu={00{HF=Bb+AEe znaSof+r1jZ!EL5XgqXWkckaFSSyEk}o!%p8XsD}O>borZ6x%X2b&q!s&1-O(>`kZ$ zB2l^5Cx9xQx9)PXN1xPM)@+LxACH_iZ8zGc(>wnFS_O|@hKsxpMjXOzLEa7OvSlM&&G9ioQw9~RsD4F zK7Q+_&|Q6{eZ^8Rx@pKL`le6kH+(fLc{=V&{b%I5=n}VHV4)X_2Y!pYxgC8wU)yP! zPF3t$?(jsC>Ge=&{kmPGUEETpaw(QTAl)m#{qR3_aq9!wK%6XHfV4C>Y^>Z|%ns7j z{Ja?^IA{+@;kR#IjHxkar%3$eJT4?xNBKUVmoO z`A8Zo-{~_;vcikZ(p}EZzU4kO6WPqkMyE{VvS?;44Z@lj zz^fKX9UL!8Wc(9VgI?P4*zpis8dzl};I>yr1>dtXU=FTAlx}Eht4-*7RACL^AflGh zyZb1hTf(~CkMo%#Q%NMgM9tE2D+)joqbtHYA89Ql1nqVTt+MxZ^*FRd&n5YlIi!8m z>$Ysd!l{+C)y;Wa(ZV-=<+NZKV;v4mt}v2m>`v$-$3b;GsLxf= zd~f(rmfpl``{0aVwN7y!>eGyJFP`L+TxHjHTOS{K^$L2`@6(Rli`{EFwpH@R%eZ6g zwf7rc43Yk!=k;{ z-Rn%~B3amGr}}SxfE$vS8FIPL=Qt57$|R#sSoFgdNUT?fYOYjPl%ZBFpi=jq=DWby7Zxm@y;B<89!9= zbgEH*Uy)~iq5kJLX$+ps$kV`#6jW#|9BGz^`ivNeid(wVbk4jl)VBpW&~;eXNi{#` zwx?{DXR~*sqQcFhY0XCfQ4-*2aN1BGX>$_swtKEqnd>j6vcZ!#0)pXRi?<{!P?tGw z2x_`RD$W)qD{?z}VDPt?+)8*rqLWFIPQ(9-VbBdf{7ff?w9CZ{sIi_gnuC$I0(+P8 zms9XB%}VQ>>pve##}jog6+cD?v~n4Pa9Vmc zg#K$|+`adO=B7`uj35Y}6EZ z{dY`x@w8;R-7zrsr1O_~Jvl*|o-x%jF=Rr1C}GXP^|IYN`1sqmG-oI@R#%X66c#5W z$$tQB)sqwiVm;Y^`Dw3mo|firP{*HsOQJre5%Dm^H@we0FN88VWJ0dja?_U38z73f zrCV!b3qNP0kM#%9T!W5`ynGcg%BL28FW1J-J1_S`BJGCaReQ!am(2%qZ3lLgzq|ns z!!fF@`0=*z)J2BwZ*hO|Yu^cI_nF$9l-Pb3jE7=P8gZ#!xiuZ7-cSa`gb`6mxGTgg z-DLdID?M!Z%+hHB#{?&0$GFRpf+_}q<_wbzX6K?w;%6szz1RbySDSr2r^h_qi$khs zXdZ9A0!_Bf)TR2-^-K~q`FQ!#1x(U4VbV%AA@Ei{%cA(EwC{XfjRi?`&9rav5;Q5% zO1`Rn@OA_ZB@N*mC#)?d3P!}Eh;=NgpIKsy{(yr`hv=aouwt@r&P&}Z3DNWo9ro30 zX52~(aTV$*HHlgB66-4GQru!_AZ|)V*I5X=WG)`N@U&D>e@@C#V@JwEL*L`7#$yes z62C^5%Qniaow2$3HrAc7U{qzpb&FA*xLI1JSWR@`RF=JCcvTI)%dH7;sWInt9JLu# z|Ao|Q?K)cDg_JKsym=joo5gR80wtv01N`um1nQ@Ms0Y*bVzxL34} zo?gizp?`=Y{*W>^Hy2%Jl)y?A+&7s1UVHFixuIy~sawXjcDCL`129cK7|ZQS0u;A} zTJC#WNmqkIrnHpAhHVcM(U^vJA~dl@jf_bs*3?i+=&vuC?Aiy_pcB~=1syDni4 zw+FLuz>F773u#$;NUQ9WDtUPY@+rA3WBhQdKFKOyzkA(URa7;4tW>3jQIfi8v0h3g zJC_HVDXS#>DWb|&se7FHnr=q&l#xg9o02}}u=b-R>@sw={Z zHF*?t2FmhqZ=|qa>x=A!*$S+0T zhO*D*M?NTf-eX`eO)9TIQu{7Dm77Acnj4b1jI9@c*ZL8wL%8kLEhd$KM8=Y!fbN@9 zC7B5#y>JM1n5M)!&im==EgHs2j+xCZG~+~QWCi?s!QyFo2kqx{%jE2n3^N*Ayz6Lp zhg5g^3# z+5FoJ@$u@9WJgPKpUWEd4}4AK9TJKU8W%ms!d0p%OIOX+bY+55zl!vIaz$XFI9Ep+ z;bL_}7PDI2Y`Ng*XY(65 zh0%`@Lve%fc;)N4_g12bNrt6gH=N#OHtxO`$lpWlw=Z6MF+E@;>GkZ#lAZTn`aHwf z&I1|aV#b_VHMIgBN*RzU9i@Z@m}0i>o?({&%fpEfaOpFeaJ7V37;m0?kzd}}Lk@9$ zL}8TEo7WZAcRi%zFZxkr6<0k#X-;lTD`Oc~cDb@olwgWCewvk{GJ}hCXbF!AdiLpd z|Cck$ZTKI?Ack{34Lva7+k=H8K2HTZiurox6F+>dy+@R9T^awxj590D$|kXUg+Ygc z(f)jlRwN(4z$#%PnOVc;#Fv{nAi{#UcXPNcmP#5O{zh_*`=q^JCeia{sN4zHjk2*y zqUVh{Ya{j>SPmP^i#Qfcq_MTqo8g52Fi^F zKBc$$HVI!xFx*4Y9l+nt)$AoZORD}%5I10oI3kx`-N30QueiwIw#0VV2E*Fb-nKW% z=+r^hos`Y-7~{cA1FVbK$_=~*z53+Q8KGjg;>ztg((H12%QTf4OYU8y)C}h5yo#$% z&Q$`vMM*g?ZcatAn2j!hFv8KuN(dw)T*}sF#THDHxo8xC^?vJ zc`U6bVo~hOr6I!8*GTZ<^D~;unKjK=!IR|GB4E>Mcvt*2GK);93jIDd<(nNjHO z4Hi@2^%Uyx=^Z~5eZ!5rO5%4H|eFoNjD#+Kcu%_57zZb4Z@Ak#X6txD^{U3wBl^r+W- zLorkK;uc;NgTj7dGxHQS+@T*T>Q*j4^Ll$ejQqWrwcHyG9y%Mk%m8nBVG5hvSaYm5 zJN^#-Q46kZG)@T8n2^QCjxIwxUVi%s>EY`E?#@_(A~njFrTiDq;8v|W-1jT|ROlNI zU$h|YoD4PVTE^&NC6_m{EAFBVqsM`P*`-AcDGWQygURzM32Xeq2xng~XQsYeTZ5v$ zQLaa2M_Iplw}4eL6fLPu`6`PYcVMysO>`{8CB~glD=TX7?JZcHfHNmykBM?QD)#D) zGp>R*<^D?WhFQKRc^}22l6F=D2RPrxaX2ZF!b1X0XF*d4%=!sbNcS1q2WOUE(7e4$ z^L8f;F)__d3>&KQFE8%$I4h^y5FYBfB&fWzn71_OSrPe-DHV{O#Q;GP z+Tw!J?eVjX19RKH?*hKQWQt8r7B#lYX8xoSHFGCW-*DSQ4EM4M3Mw%gkSYNK18@(e zfzMF}WWaCyS@1y%-~Xg0ry~tkQkUmKuI5lGAua{{vn22V!2T()AU5FpKh@Nv)s^Js zv~@VuUG;=CnLmQR{PeUBQf2;lAV!vG>^Z0N zL88rrjL-*J!43;7C=w9xhcw`yjRKq7o4L9=0SmR9PA-nX12@#h(iIu-0N_xm2OV)( zU_raT0y>$wm^oMi2|U3N;OhF9uy}`<-xVka#DV*l{O0yHzi9vUxa1Qtpi$buR*8cU zd4~lS1pT$L^!0=6qUKOpM+XPsy{f7W#1bjrEwaeN!Ik9(zySIT^pEHvHgJUneFN4) zk=k|$55(g8slmS|@+*4fr2urd3LwjIIZA**g+%l(SZNn4HwQ}y6o`vw>2&mR1X+&q zDa1Af0B;4rAMZMOlHbAqK|R_xuwJ7ANARtFE({-P2o{tJJR<>2KVp)ZK-M;)ejx zd*E~Mka<{OL7%CAhk4n|1qg?97-I!l0rOinjVi#arbgg4bi5;nY5oFL`UWtPk5&L#grSxv zE3!}=1px!ZTLT90aYc^s`~{VojjJml&<`@e41dFP+XU6D0AOkbn2rlI3>^LcqauG& zc$m3Z{!u8LvUrm^fT{qX5yD9{?r(CCiUdck%!T`KIZd2oQJz1joB&M(Teg_>;yS<2-5>BWfSPpG`Rt{!j6>kqMAvl^zk0JUEfy$HVJMkxP-GkwZuxL62me2#pj_5*ZIU zP~#C^OZLfl$HO)v;~~c&JHivn|1I9H5y_CDkt0JLLGKm(4*KLVhJ2jh2#vJuM6`b& zE==-lvME^Oj022xF&IV*? '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/powertools-examples-core-utilities/gradle/gradlew.bat b/examples/powertools-examples-core-utilities/gradle/gradlew.bat new file mode 100644 index 000000000..93e3f59f1 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java new file mode 100644 index 000000000..fccc63b9a --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java @@ -0,0 +1,107 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 helloworld; + +import static software.amazon.lambda.powertools.metrics.MetricsUtils.metricsLogger; +import static software.amazon.lambda.powertools.metrics.MetricsUtils.withSingleMetric; +import static software.amazon.lambda.powertools.tracing.TracingUtils.putMetadata; + +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.RequestHandler; +import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; +import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URL; +import java.util.HashMap; +import java.util.Map; +import java.util.stream.Collectors; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import software.amazon.cloudwatchlogs.emf.model.DimensionSet; +import software.amazon.cloudwatchlogs.emf.model.Unit; +import software.amazon.lambda.powertools.logging.Logging; +import software.amazon.lambda.powertools.logging.LoggingUtils; +import software.amazon.lambda.powertools.metrics.Metrics; +import software.amazon.lambda.powertools.tracing.CaptureMode; +import software.amazon.lambda.powertools.tracing.Tracing; +import software.amazon.lambda.powertools.tracing.TracingUtils; + +/** + * Handler for requests to Lambda function. + */ +public class App implements RequestHandler { + private final static Logger log = LogManager.getLogger(App.class); + + @Logging(logEvent = true, samplingRate = 0.7) + @Tracing(captureMode = CaptureMode.RESPONSE_AND_ERROR) + @Metrics(namespace = "ServerlessAirline", service = "payment", captureColdStart = true) + public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEvent input, final Context context) { + Map headers = new HashMap<>(); + + headers.put("Content-Type", "application/json"); + headers.put("X-Custom-Header", "application/json"); + + metricsLogger().putMetric("CustomMetric1", 1, Unit.COUNT); + + withSingleMetric("CustomMetrics2", 1, Unit.COUNT, "Another", (metric) -> + { + metric.setDimensions(DimensionSet.of("AnotherService", "CustomService")); + metric.setDimensions(DimensionSet.of("AnotherService1", "CustomService1")); + }); + + LoggingUtils.appendKey("test", "willBeLogged"); + + APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent() + .withHeaders(headers); + try { + final String pageContents = this.getPageContents("https://checkip.amazonaws.com"); + log.info(pageContents); + TracingUtils.putAnnotation("Test", "New"); + String output = String.format("{ \"message\": \"hello world\", \"location\": \"%s\" }", pageContents); + + TracingUtils.withSubsegment("loggingResponse", subsegment -> + { + String sampled = "log something out"; + log.info(sampled); + log.info(output); + }); + + log.info("After output"); + return response + .withStatusCode(200) + .withBody(output); + } catch (RuntimeException | IOException e) { + return response + .withBody("{}") + .withStatusCode(500); + } + } + + @Tracing + private void log() { + log.info("inside threaded logging for function"); + } + + @Tracing(namespace = "getPageContents", captureMode = CaptureMode.DISABLED) + private String getPageContents(String address) throws IOException { + URL url = new URL(address); + putMetadata("getPageContents", address); + try (BufferedReader br = new BufferedReader(new InputStreamReader(url.openStream()))) { + return br.lines().collect(Collectors.joining(System.lineSeparator())); + } + } +} diff --git a/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/AppStream.java b/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/AppStream.java new file mode 100644 index 000000000..401ef8c48 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/AppStream.java @@ -0,0 +1,38 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 helloworld; + +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.RequestStreamHandler; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.Map; +import software.amazon.lambda.powertools.logging.Logging; +import software.amazon.lambda.powertools.metrics.Metrics; + +public class AppStream implements RequestStreamHandler { + private static final ObjectMapper mapper = new ObjectMapper(); + + @Override + @Logging(logEvent = true) + @Metrics(namespace = "ServerlessAirline", service = "payment", captureColdStart = true) + public void handleRequest(InputStream input, OutputStream output, Context context) throws IOException { + Map map = mapper.readValue(input, Map.class); + + System.out.println(map.size()); + } +} diff --git a/examples/powertools-examples-core-utilities/gradle/src/test/java/helloworld/AppTest.java b/examples/powertools-examples-core-utilities/gradle/src/test/java/helloworld/AppTest.java new file mode 100644 index 000000000..af3ec1275 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/src/test/java/helloworld/AppTest.java @@ -0,0 +1,24 @@ +package helloworld; + +import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; + +public class AppTest { + @Test + public void successfulResponse() { + App app = new App(); + APIGatewayProxyResponseEvent result = app.handleRequest(null, null); + assertEquals(200, result.getStatusCode().intValue()); + assertEquals("application/json", result.getHeaders().get("Content-Type")); + String content = result.getBody(); + assertNotNull(content); + assertTrue(content.contains("\"message\"")); + assertTrue(content.contains("\"hello world\"")); + assertTrue(content.contains("\"location\"")); + } +} diff --git a/examples/powertools-examples-core-utilities/gradle/template.yaml b/examples/powertools-examples-core-utilities/gradle/template.yaml new file mode 100644 index 000000000..a717c2998 --- /dev/null +++ b/examples/powertools-examples-core-utilities/gradle/template.yaml @@ -0,0 +1,71 @@ +AWSTemplateFormatVersion: '2010-09-09' +Transform: AWS::Serverless-2016-10-31 +Description: > + gradle + + Sample SAM Template for gradle + +# More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst +Globals: + Function: + Timeout: 20 + Runtime: java11 + MemorySize: 512 + Tracing: Active # https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html + Environment: + Variables: + # Powertools for AWS Lambda (Java) env vars: https://docs.powertools.aws.dev/lambda/java/#environment-variables + POWERTOOLS_LOG_LEVEL: INFO + POWERTOOLS_LOGGER_SAMPLE_RATE: 0.1 + POWERTOOLS_LOGGER_LOG_EVENT: true + POWERTOOLS_METRICS_NAMESPACE: Coreutilities + +Resources: + HelloWorldFunction: + Type: AWS::Serverless::Function # More info about Function Resource: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction + Properties: + CodeUri: . + Handler: helloworld.App::handleRequest + Runtime: java8 + MemorySize: 512 + Environment: # More info about Env Vars: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object + Variables: + POWERTOOLS_SERVICE_NAME: hello + Events: + HelloWorld: + Type: Api # More info about API Event Source: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api + Properties: + Path: /hello + Method: get + + HelloWorldStreamFunction: + Type: AWS::Serverless::Function + Properties: + CodeUri: . + Handler: helloworld.AppStream::handleRequest + Runtime: java8 + MemorySize: 512 + Tracing: Active + Environment: + Variables: + POWERTOOLS_LOGGER_SAMPLE_RATE: 0.7 + Events: + HelloWorld: + Type: Api + Properties: + Path: /hellostream + Method: get + +Outputs: + # ServerlessRestApi is an implicit API created out of Events key under Serverless::Function + # Find out more about other implicit resources you can reference within SAM + # https://github.com/awslabs/serverless-application-model/blob/master/docs/internals/generated_resources.rst#api + HelloWorldApi: + Description: "API Gateway endpoint URL for Prod stage for Hello World function" + Value: !Sub "https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/hello/" + HelloWorldFunction: + Description: "Hello World Lambda Function ARN" + Value: !GetAtt HelloWorldFunction.Arn + HelloWorldFunctionIamRole: + Description: "Implicit IAM Role created for Hello World function" + Value: !GetAtt HelloWorldFunctionRole.Arn diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock b/examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock new file mode 100644 index 0000000000000000000000000000000000000000..ab02aac0d7cc045b38c939b191240bf8d3f2af7b GIT binary patch literal 17 TcmZS1{PFajnc1pM3{U_7KIjDS literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin b/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin new file mode 100644 index 0000000000000000000000000000000000000000..f76dd238ade08917e6712764a16a22005a50573d GIT binary patch literal 1 IcmZPo000310RR91 literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock b/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock new file mode 100644 index 0000000000000000000000000000000000000000..d082a98bc5aa56290fd95d661efc99fba8107d56 GIT binary patch literal 17 ScmZSH5|xnB;%B#w0SW*udIOvQ literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties b/examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties new file mode 100644 index 000000000..e69de29bb diff --git a/examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties b/examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties new file mode 100644 index 000000000..e69de29bb diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java index a13c85496..4475cd439 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java @@ -16,7 +16,5 @@ String application(); - Class provider(); - Class transformer() default Transformer.class; } diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index d9596e64f..66a91b4b7 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -26,12 +26,15 @@ @Aspect public class AppConfigParametersAspect { + @Pointcut("get(* *) && @annotation(appConfigParamAnnotation)") public void getParam(AppConfigParam appConfigParamAnnotation) { } @Around("getParam(appConfigParamAnnotation)") public Object injectParam(final ProceedingJoinPoint joinPoint, final AppConfigParam appConfigParamAnnotation) { + System.out.println("GET IT"); + AppConfigProvider provider = AppConfigProvider.builder() .withEnvironment(appConfigParamAnnotation.environment()) .withApplication(appConfigParamAnnotation.application()) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java index cf35f27a9..027f828a3 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java @@ -143,7 +143,7 @@ static class Builder { */ public AppConfigProvider build() { if (cacheManager == null) { - throw new IllegalStateException("No CacheManager provided; please provide one"); + cacheManager = new CacheManager(); } if (environment == null) { throw new IllegalStateException("No environment provided; please provide one"); diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java new file mode 100644 index 000000000..6953c51ff --- /dev/null +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java @@ -0,0 +1,20 @@ +package software.amazon.lambda.powertools.parameters.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; + +import org.junit.jupiter.api.Test; + +// TODO - what can we do with this? We need a way to inject a different +// AppConfigDataClient in +//public class AppConfigParamAspectTest { +// +// @AppConfigParam(application = "myApp", environment = "myEnvironment", key = "myKey") +// public String myParameter; +// +// @Test +// public void parameterInjectedByProvider() { +// assertThat(myParameter); +// } +// +//} diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java index 780e3cb37..992fc64eb 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java @@ -190,18 +190,6 @@ public void getMultipleValuesThrowsException() { .withMessage("Retrieving multiple parameter values is not supported with the AWS App Config Provider"); } - @Test - public void testAppConfigProviderBuilderMissingCacheManager_throwsException() { - - // Act & Assert - Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() - .withEnvironment(environmentName) - .withApplication(applicationName) - .withClient(client) - .build()) - .withMessage("No CacheManager provided; please provide one"); - } - @Test public void testAppConfigProviderBuilderMissingEnvironment_throwsException() { diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java new file mode 100644 index 000000000..6b62838fb --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java @@ -0,0 +1,17 @@ +package software.amazon.lambda.powertools.parameters.dynamodb; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import software.amazon.lambda.powertools.parameters.transform.Transformer; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface DynamoDbParam { + String key(); + + String table(); + + Class transformer() default Transformer.class; +} diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java new file mode 100644 index 000000000..0d5d0d7a7 --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -0,0 +1,58 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.dynamodb; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Pointcut; +import org.aspectj.lang.reflect.FieldSignature; + +@Aspect +public class DynamoDbParamAspect { + + + @Pointcut("get(* *) && @annotation(ddbConfigParam)") + public void getParam(DynamoDbParam ddbConfigParam) { + } + + @Around("getParam(ddbConfigParam)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final DynamoDbParam ddbConfigParam) { + System.out.println("GET IT"); + + DynamoDbProvider provider = DynamoDbProvider.builder() + .withTable(ddbConfigParam.table()) + .build(); + + if (ddbConfigParam.transformer().isInterface()) { + // No transformation + return provider.get(ddbConfigParam.key()); + } else { + FieldSignature s = (FieldSignature) joinPoint.getSignature(); + if (String.class.isAssignableFrom(s.getFieldType())) { + // Basic transformation + return provider + .withTransformation(ddbConfigParam.transformer()) + .get(ddbConfigParam.key()); + } else { + // Complex transformation + return provider + .withTransformation(ddbConfigParam.transformer()) + .get(ddbConfigParam.key(), s.getFieldType()); + } + } + } + +} diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index 27daf780e..d937121a7 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -150,7 +150,7 @@ private static DynamoDbClient createClient() { */ public DynamoDbProvider build() { if (cacheManager == null) { - throw new IllegalStateException("No CacheManager provided; please provide one"); + cacheManager = new CacheManager(); } if (table == null) { throw new IllegalStateException("No DynamoDB table name provided; please provide one"); diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java new file mode 100644 index 000000000..5ca05f4de --- /dev/null +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java @@ -0,0 +1,15 @@ +package software.amazon.lambda.powertools.parameters.secrets; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import software.amazon.lambda.powertools.parameters.transform.Transformer; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface SecretsParam { + String key(); + + Class transformer() default Transformer.class; +} diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java new file mode 100644 index 000000000..b38b8b0cd --- /dev/null +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -0,0 +1,57 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.secrets; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Pointcut; +import org.aspectj.lang.reflect.FieldSignature; + +@Aspect +public class SecretsParamAspect { + + + @Pointcut("get(* *) && @annotation(secretsParam)") + public void getParam(SecretsParam secretsParam) { + } + + @Around("getParam(secretsParam)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final SecretsParam secretsParam) { + System.out.println("GET IT"); + + SecretsProvider provider = SecretsProvider.builder() + .build(); + + if (secretsParam.transformer().isInterface()) { + // No transformation + return provider.get(secretsParam.key()); + } else { + FieldSignature s = (FieldSignature) joinPoint.getSignature(); + if (String.class.isAssignableFrom(s.getFieldType())) { + // Basic transformation + return provider + .withTransformation(secretsParam.transformer()) + .get(secretsParam.key()); + } else { + // Complex transformation + return provider + .withTransformation(secretsParam.transformer()) + .get(secretsParam.key(), s.getFieldType()); + } + } + } + +} diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java new file mode 100644 index 000000000..b8ce2e870 --- /dev/null +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java @@ -0,0 +1,15 @@ +package software.amazon.lambda.powertools.parameters.ssm; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import software.amazon.lambda.powertools.parameters.transform.Transformer; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface SSMParam { + String key(); + + Class transformer() default Transformer.class; +} diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java new file mode 100644 index 000000000..320aff33a --- /dev/null +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -0,0 +1,57 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.ssm; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Pointcut; +import org.aspectj.lang.reflect.FieldSignature; + +@Aspect +public class SSMParamAspect { + + + @Pointcut("get(* *) && @annotation(secretsParam)") + public void getParam(SSMParam secretsParam) { + } + + @Around("getParam(SSMParam)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam SSMParam) { + System.out.println("GET IT"); + + SSMProvider provider = SSMProvider.builder() + .build(); + + if (SSMParam.transformer().isInterface()) { + // No transformation + return provider.get(SSMParam.key()); + } else { + FieldSignature s = (FieldSignature) joinPoint.getSignature(); + if (String.class.isAssignableFrom(s.getFieldType())) { + // Basic transformation + return provider + .withTransformation(SSMParam.transformer()) + .get(SSMParam.key()); + } else { + // Complex transformation + return provider + .withTransformation(SSMParam.transformer()) + .get(SSMParam.key(), s.getFieldType()); + } + } + } + +} diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java index db64c31fd..5c213a328 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java @@ -48,46 +48,46 @@ public void testGetTransformationManager() { assertNotNull(transformationManager); } - @Test - public void testCreateProvider() { - - // Act - CustomProvider customProvider = ParamManager.createProvider(CustomProvider.class); - - // Assert - assertNotNull(customProvider); - } - - @Test - public void testCreateUninstanciableProvider_throwsException() { - - // Act & Assert - assertThatRuntimeException().isThrownBy(() -> ParamManager.createProvider(BaseProvider.class)); - } - - @Test - public void testGetProviderWithProviderClass() { - +// @Test +// public void testCreateProvider() { +// // Act - SecretsProvider secretsProvider = ParamManager.getProvider(SecretsProvider.class); - - // Assert - assertNotNull(secretsProvider); - } - - @Test - public void testGetProviderWithProviderClass_throwsException() { - - // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> ParamManager.getProvider(null)); - } - - - @Test - public void testGetDynamoDBProvider_requireOtherParameters_throwException() { - - // Act & Assert - assertThatIllegalArgumentException().isThrownBy(() -> ParamManager.getProvider(DynamoDbProvider.class)); - } +// CustomProvider customProvider = ParamManager.createProvider(CustomProvider.class); +// +// // Assert +// assertNotNull(customProvider); +// } +// +// @Test +// public void testCreateUninstanciableProvider_throwsException() { +// +// // Act & Assert +// assertThatRuntimeException().isThrownBy(() -> ParamManager.createProvider(BaseProvider.class)); +// } +// +// @Test +// public void testGetProviderWithProviderClass() { +// +// // Act +// SecretsProvider secretsProvider = ParamManager.getProvider(SecretsProvider.class); +// +// // Assert +// assertNotNull(secretsProvider); +// } +// +// @Test +// public void testGetProviderWithProviderClass_throwsException() { +// +// // Act & Assert +// assertThatIllegalStateException().isThrownBy(() -> ParamManager.getProvider(null)); +// } +// +// +// @Test +// public void testGetDynamoDBProvider_requireOtherParameters_throwException() { +// +// // Act & Assert +// assertThatIllegalArgumentException().isThrownBy(() -> ParamManager.getProvider(DynamoDbProvider.class)); +// } } diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java index 4fad5ff8f..348f9ab82 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java @@ -30,27 +30,29 @@ public class LambdaParametersAspect { public void getParam(Param paramAnnotation) { } - @Around("getParam(paramAnnotation)") - public Object injectParam(final ProceedingJoinPoint joinPoint, final Param paramAnnotation) { - BaseProvider provider = ParamManager.getProvider(paramAnnotation.provider()); + // TODO - get rid of this - if (paramAnnotation.transformer().isInterface()) { - // No transformation - return provider.get(paramAnnotation.key()); - } else { - FieldSignature s = (FieldSignature) joinPoint.getSignature(); - if (String.class.isAssignableFrom(s.getFieldType())) { - // Basic transformation - return provider - .withTransformation(paramAnnotation.transformer()) - .get(paramAnnotation.key()); - } else { - // Complex transformation - return provider - .withTransformation(paramAnnotation.transformer()) - .get(paramAnnotation.key(), s.getFieldType()); - } - } - } +// @Around("getParam(paramAnnotation)") +// public Object injectParam(final ProceedingJoinPoint joinPoint, final Param paramAnnotation) { +// BaseProvider provider = ParamManager.getProvider(paramAnnotation.provider()); +// +// if (paramAnnotation.transformer().isInterface()) { +// // No transformation +// return provider.get(paramAnnotation.key()); +// } else { +// FieldSignature s = (FieldSignature) joinPoint.getSignature(); +// if (String.class.isAssignableFrom(s.getFieldType())) { +// // Basic transformation +// return provider +// .withTransformation(paramAnnotation.transformer()) +// .get(paramAnnotation.key()); +// } else { +// // Complex transformation +// return provider +// .withTransformation(paramAnnotation.transformer()) +// .get(paramAnnotation.key(), s.getFieldType()); +// } +// } +// } } From 357f85968a670c69ca582238513629bf0530bff2 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 13:23:08 +0200 Subject: [PATCH 07/45] More rejigging --- .../appconfig/AppConfigParametersAspect.java | 3 - .../parameters/dynamodb/DynamoDbProvider.java | 2 +- .../DynamoDbProviderSchemaException.java | 2 +- .../dynamodb/DynamoDbProviderTest.java | 2 +- .../LambdaParametersAspectTest.java | 97 ------------------- .../parameters/LambdaParametersAspect.java | 58 ----------- .../lambda/powertools/parameters/Param.java | 45 --------- 7 files changed, 3 insertions(+), 206 deletions(-) rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb}/exception/DynamoDbProviderSchemaException.java (92%) delete mode 100644 powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java delete mode 100644 powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java delete mode 100644 powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index 66a91b4b7..636242715 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -19,9 +19,6 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; -import software.amazon.lambda.powertools.parameters.BaseProvider; -import software.amazon.lambda.powertools.parameters.Param; -import software.amazon.lambda.powertools.parameters.ParamManager; @Aspect public class AppConfigParametersAspect { diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index d937121a7..b665b1e35 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -32,7 +32,7 @@ import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; -import software.amazon.lambda.powertools.parameters.exception.DynamoDbProviderSchemaException; +import software.amazon.lambda.powertools.parameters.dynamodb.exception.DynamoDbProviderSchemaException; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; /** diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/exception/DynamoDbProviderSchemaException.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/exception/DynamoDbProviderSchemaException.java similarity index 92% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/exception/DynamoDbProviderSchemaException.java rename to powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/exception/DynamoDbProviderSchemaException.java index 77df6e3d3..4a22dbc99 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/exception/DynamoDbProviderSchemaException.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/exception/DynamoDbProviderSchemaException.java @@ -12,7 +12,7 @@ * */ -package software.amazon.lambda.powertools.parameters.exception; +package software.amazon.lambda.powertools.parameters.dynamodb.exception; /** * Thrown when the DynamoDbProvider comes across parameter data that diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java index 7e5b5f631..47d04907a 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java @@ -35,7 +35,7 @@ import software.amazon.awssdk.services.dynamodb.model.QueryRequest; import software.amazon.awssdk.services.dynamodb.model.QueryResponse; import software.amazon.lambda.powertools.parameters.cache.CacheManager; -import software.amazon.lambda.powertools.parameters.exception.DynamoDbProviderSchemaException; +import software.amazon.lambda.powertools.parameters.dynamodb.exception.DynamoDbProviderSchemaException; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; public class DynamoDbProviderTest { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java deleted file mode 100644 index 0fb945554..000000000 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspectTest.java +++ /dev/null @@ -1,97 +0,0 @@ -package software.amazon.lambda.powertools.parameters;/* - * Copyright 2023 Amazon.com, Inc. or its affiliates. - * Licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License 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. - * - */ - -import org.assertj.core.api.Assertions; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import software.amazon.lambda.powertools.parameters.exception.TransformationException; -import software.amazon.lambda.powertools.parameters.internal.AnotherObject; -import software.amazon.lambda.powertools.parameters.internal.CustomProvider; -import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; -import software.amazon.lambda.powertools.parameters.transform.Base64Transformer; -import software.amazon.lambda.powertools.parameters.transform.JsonTransformer; -import software.amazon.lambda.powertools.parameters.transform.ObjectToDeserialize; - -public class LambdaParametersAspectTest { - - @Mock - private SSMProvider defaultProvider; - -// @Param(key = "/default", provider = SSMProvider.class) -// private String defaultValue; - - @Param(key = "/simple", provider = CustomProvider.class) - private String param; - - @Param(key = "/base64", provider = CustomProvider.class, transformer = Base64Transformer.class) - private String basicTransform; - - @Param(key = "/json", provider = CustomProvider.class, transformer = JsonTransformer.class) - private ObjectToDeserialize complexTransform; - - @Param(key = "/json", provider = CustomProvider.class, transformer = JsonTransformer.class) - private AnotherObject wrongTransform; - - @BeforeEach - public void init() { - MockitoAnnotations.openMocks(this); - } - - // @Test - // TODO - no more defaults! -// public void testDefault_ShouldUseSSMProvider() { -// try (MockedStatic mocked = Mockito.mockStatic(ParamManager.class)) { -// mocked.when(() -> ParamManager.getProvider(SSMProvider.class)).thenReturn(defaultProvider); -// Mockito.when(defaultProvider.get("/default")).thenReturn("value"); -// -// Assertions.assertThat(defaultValue).isEqualTo("value"); -// mocked.verify(() -> ParamManager.getProvider(SSMProvider.class), Mockito.times(1)); -// Mockito.verify(defaultProvider, Mockito.times(1)).get("/default"); -// -// mocked.reset(); -// } -// } - - @Test - public void testSimple() { - Assertions.assertThat(param).isEqualTo("value"); - } - - @Test - public void testWithBasicTransform() { - Assertions.assertThat(basicTransform).isEqualTo("value"); - } - - @Test - public void testWithComplexTransform() { - Assertions.assertThat(complexTransform) - .isInstanceOf(ObjectToDeserialize.class) - .matches( - o -> o.getFoo().equals("Foo") && - o.getBar() == 42 && - o.getBaz() == 123456789); - } - - @Test - public void testWithComplexTransformWrongTargetClass_ShouldThrowException() { - Assertions.assertThatExceptionOfType(TransformationException.class) - .isThrownBy(() -> - { - AnotherObject obj = wrongTransform; - }); - } - -} diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java deleted file mode 100644 index 348f9ab82..000000000 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/LambdaParametersAspect.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright 2023 Amazon.com, Inc. or its affiliates. - * Licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License 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.lambda.powertools.parameters; - -import org.aspectj.lang.ProceedingJoinPoint; -import org.aspectj.lang.annotation.Around; -import org.aspectj.lang.annotation.Aspect; -import org.aspectj.lang.annotation.Pointcut; -import org.aspectj.lang.reflect.FieldSignature; -import software.amazon.lambda.powertools.parameters.BaseProvider; -import software.amazon.lambda.powertools.parameters.Param; -import software.amazon.lambda.powertools.parameters.ParamManager; - -@Aspect -public class LambdaParametersAspect { - - @Pointcut("get(* *) && @annotation(paramAnnotation)") - public void getParam(Param paramAnnotation) { - } - - // TODO - get rid of this - -// @Around("getParam(paramAnnotation)") -// public Object injectParam(final ProceedingJoinPoint joinPoint, final Param paramAnnotation) { -// BaseProvider provider = ParamManager.getProvider(paramAnnotation.provider()); -// -// if (paramAnnotation.transformer().isInterface()) { -// // No transformation -// return provider.get(paramAnnotation.key()); -// } else { -// FieldSignature s = (FieldSignature) joinPoint.getSignature(); -// if (String.class.isAssignableFrom(s.getFieldType())) { -// // Basic transformation -// return provider -// .withTransformation(paramAnnotation.transformer()) -// .get(paramAnnotation.key()); -// } else { -// // Complex transformation -// return provider -// .withTransformation(paramAnnotation.transformer()) -// .get(paramAnnotation.key(), s.getFieldType()); -// } -// } -// } - -} diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java deleted file mode 100644 index d456cbd99..000000000 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/Param.java +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright 2023 Amazon.com, Inc. or its affiliates. - * Licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License 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.lambda.powertools.parameters; - -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; -import software.amazon.lambda.powertools.parameters.transform.Transformer; - -/** - * {@code Param} is used to signal that the annotated field should be - * populated with a value retrieved from a parameter store through a {@link ParamProvider}. - * - *

By default {@code Param} use {@link SSMProvider} as parameter provider. This can be overridden specifying - * the annotation variable {@code Param(provider = )}.
- * The library provide a provider for AWS System Manager Parameters Store ({@link SSMProvider}) and a provider - * for AWS Secrets Manager ({@link SecretsProvider}). - * The user can implement a custom provider by extending the abstract class {@link BaseProvider}.

- * - *

If the parameter value requires transformation before being assigned to the annotated field - * users can specify a {@link Transformer} - *

- */ -@Retention(RetentionPolicy.RUNTIME) -@Target(ElementType.FIELD) -public @interface Param { - String key(); - - Class provider(); - - Class transformer() default Transformer.class; -} From e93b1d0a4d51774fdff292d066cf2a1cf154e0bf Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 14:17:05 +0200 Subject: [PATCH 08/45] Fix build? --- .../org/demo/parameters/ParametersFunction.java | 10 ++++++++++ .../parameters/appconfig/AppConfigParam.java | 15 ++++++++++++++- .../appconfig/AppConfigParamAspectTest.java | 5 ----- .../parameters/dynamodb/DynamoDbParam.java | 14 ++++++++++++++ .../dynamodb/DynamoDbProviderTest.java | 9 --------- .../parameters/secrets/SecretsParam.java | 14 ++++++++++++++ .../powertools/parameters/ssm/SSMParam.java | 14 ++++++++++++++ .../powertools/parameters/ssm/SSMProvider.java | 1 - .../parameters/ssm/SSMProviderTest.java | 17 ----------------- .../parameters/ParamManagerIntegrationTest.java | 2 +- 10 files changed, 67 insertions(+), 34 deletions(-) diff --git a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java index 6eb52a165..7cf4f90e4 100644 --- a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java +++ b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java @@ -32,12 +32,22 @@ import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import software.amazon.lambda.powertools.parameters.ParamManager; +import software.amazon.lambda.powertools.parameters.secrets.SecretsParam; import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; +import software.amazon.lambda.powertools.parameters.ssm.SSMParam; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; public class ParametersFunction implements RequestHandler { private final static Logger log = LogManager.getLogger(ParametersFunction.class); + // Annotation-style injection from secrets manager + @SecretsParam(key = "/powertools-java/userpwd") + String secretParamInjected; + + // Annotation-style injection from Systems Manager + @SSMParam(key = "/powertools-java/sample/simplekey") + String ssmParamInjected; + SSMProvider ssmProvider = SSMProvider .builder() .build(); diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java index 4475cd439..d4b024b6a 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java @@ -1,10 +1,23 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.appconfig; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.transform.Transformer; @Retention(RetentionPolicy.RUNTIME) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java index 6953c51ff..2337c4c9d 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java @@ -1,10 +1,5 @@ package software.amazon.lambda.powertools.parameters.appconfig; -import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.Mockito.mock; - -import org.junit.jupiter.api.Test; - // TODO - what can we do with this? We need a way to inject a different // AppConfigDataClient in //public class AppConfigParamAspectTest { diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java index 6b62838fb..45c3b83aa 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.dynamodb; import java.lang.annotation.ElementType; diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java index 47d04907a..0d0fbd2d9 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java @@ -217,15 +217,6 @@ public void getValuesWithMalformedRowThrows() { }); } - @Test - public void testDynamoDBBuilderMissingCacheManager_throwsException() { - - // Act & Assert - assertThatIllegalStateException().isThrownBy(() -> DynamoDbProvider.builder() - .withTable("table") - .build()); - } - @Test public void testDynamoDBBuilderMissingTable_throwsException() { diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java index 5ca05f4de..a9e7f5646 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.secrets; import java.lang.annotation.ElementType; diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java index b8ce2e870..ced673829 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.ssm; import java.lang.annotation.ElementType; diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java index 7f308228d..a21821009 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java @@ -29,7 +29,6 @@ import software.amazon.awssdk.utils.StringUtils; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; -import software.amazon.lambda.powertools.parameters.ParamManager; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; import software.amazon.lambda.powertools.parameters.transform.Transformer; diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index a85f71727..bdbc97f7c 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -16,12 +16,6 @@ import static java.util.Arrays.asList; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatIllegalStateException; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; -import static org.mockito.MockitoAnnotations.openMocks; import java.time.temporal.ChronoUnit; import java.util.ArrayList; @@ -200,17 +194,6 @@ public void getMultipleWithNextToken() { Assertions.assertThat(request2.nextToken()).isEqualTo("123abc"); } - @Test - public void testSecretsProviderBuilderMissingCacheManager_throwsException() { - - // Act & Assert - Assertions.assertThatIllegalStateException().isThrownBy(() -> SSMProvider.builder() - .withClient(client) - .withTransformationManager(transformationManager) - .build()) - .withMessage("No CacheManager provided, please provide one"); - } - private void initMock(String expectedValue) { Parameter parameter = Parameter.builder().value(expectedValue).build(); GetParameterResponse result = GetParameterResponse.builder().parameter(parameter).build(); diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java index e06dd7e13..dce1bf664 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java @@ -65,7 +65,7 @@ public class ParamManagerIntegrationTest { public void setup() throws IllegalAccessException { openMocks(this); - writeStaticField(ParamManager.class, "providers", new ConcurrentHashMap<>(), true); + //writeStaticField(ParamManager.class, "providers", new ConcurrentHashMap<>(), true); } @Test From 69619e8b9dc99a4929204f4494f1d50ce699a1b5 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 15:12:39 +0200 Subject: [PATCH 09/45] spotbugs exclude path change --- pom.xml | 2 +- .../amazon/lambda/powertools/parameters/dynamodb/Builder.java | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java diff --git a/pom.xml b/pom.xml index 47cc228db..f52c3f409 100644 --- a/pom.xml +++ b/pom.xml @@ -511,7 +511,7 @@ true - ../spotbugs-exclude.xml + ${project.basedir}/spotbugs-exclude.xml diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java new file mode 100644 index 000000000..ad7dbf6db --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java @@ -0,0 +1,2 @@ +package software.amazon.lambda.powertools.parameters.dynamodb;public class Builder { +} From 9bfff82635a836e60ba9ea83fd9a94684b0760af Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 15:18:42 +0200 Subject: [PATCH 10/45] More excludes --- powertools-parameters/spotbugs-exclude.xml | 37 ++++++++++++++++++++++ spotbugs-exclude.xml | 16 ---------- 2 files changed, 37 insertions(+), 16 deletions(-) create mode 100644 powertools-parameters/spotbugs-exclude.xml diff --git a/powertools-parameters/spotbugs-exclude.xml b/powertools-parameters/spotbugs-exclude.xml new file mode 100644 index 000000000..98536870b --- /dev/null +++ b/powertools-parameters/spotbugs-exclude.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml index eca7e266f..fd1ef6f44 100644 --- a/spotbugs-exclude.xml +++ b/spotbugs-exclude.xml @@ -65,14 +65,6 @@ - - - - - - - - @@ -140,18 +132,10 @@ - - - - - - - - From f1106d4639433fe4e0e3c26be2f4fc741241493c Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Sep 2023 15:21:39 +0200 Subject: [PATCH 11/45] Fix pom --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index f52c3f409..47cc228db 100644 --- a/pom.xml +++ b/pom.xml @@ -511,7 +511,7 @@ true - ${project.basedir}/spotbugs-exclude.xml + ../spotbugs-exclude.xml From 5ce1d868173bc6b82bc18f0cf66cf354a6ed9187 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Mon, 11 Sep 2023 16:39:20 +0200 Subject: [PATCH 12/45] Trying to write an aspect test --- .../.gradle/7.3.3/checksums/checksums.lock | Bin 0 -> 17 bytes .../.gradle/7.3.3/fileChanges/last-build.bin | Bin 0 -> 1 bytes .../.gradle/7.3.3/fileHashes/fileHashes.lock | Bin 0 -> 17 bytes .../gradle/.gradle/7.3.3/gc.properties | 0 .../gradle/.gradle/vcs-1/gc.properties | 0 .../demo/parameters/ParametersFunction.java | 1 - .../internal/LargeMessageProcessor.java | 1 + .../appconfig/AppConfigParametersAspect.java | 13 +- .../appconfig/AppConfigProvider.java | 115 +----------------- .../appconfig/AppConfigProviderBuilder.java | 106 ++++++++++++++++ .../appconfig/AppConfigParamAspectTest.java | 52 ++++++-- .../parameters/dynamodb/Builder.java | 2 - .../parameters/dynamodb/DynamoDbProvider.java | 105 +--------------- .../dynamodb/DynamoDbProviderBuilder.java | 95 +++++++++++++++ .../dynamodb/DynamoDbProviderE2ETest.java | 2 +- .../dynamodb/DynamoDbProviderTest.java | 2 +- .../parameters/secrets/SecretsProvider.java | 102 +--------------- .../secrets/SecretsProviderBuilder.java | 83 +++++++++++++ .../secrets/SecretsProviderTest.java | 2 +- .../parameters/ssm/SSMProvider.java | 91 ++------------ .../parameters/ssm/SSMProviderBuilder.java | 82 +++++++++++++ .../parameters/ssm/SSMProviderTest.java | 2 +- .../parameters/BaseProviderTest.java | 5 +- .../parameters/ParamManagerTest.java | 93 -------------- .../parameters/internal/CustomProvider.java | 2 +- .../powertools/parameters/BaseProvider.java | 9 +- .../powertools/parameters/ParamManager.java | 38 ------ 27 files changed, 448 insertions(+), 555 deletions(-) create mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock create mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin create mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock create mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties create mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties create mode 100644 powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java delete mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java create mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java create mode 100644 powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java create mode 100644 powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java delete mode 100644 powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java delete mode 100644 powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock new file mode 100644 index 0000000000000000000000000000000000000000..137f02edd07205014ea750fc7f5af43c8b21b0d3 GIT binary patch literal 17 TcmZQR;rp-S!lD1O8K3|FN0J50 literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin new file mode 100644 index 0000000000000000000000000000000000000000..f76dd238ade08917e6712764a16a22005a50573d GIT binary patch literal 1 IcmZPo000310RR91 literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock new file mode 100644 index 0000000000000000000000000000000000000000..d2358784bf82bce372f41c1be1b805984af62bf7 GIT binary patch literal 17 TcmZSPKFMA;$xm%90~7!NB}M}f literal 0 HcmV?d00001 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties new file mode 100644 index 000000000..e69de29bb diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties b/examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties new file mode 100644 index 000000000..e69de29bb diff --git a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java index 7cf4f90e4..57f953d43 100644 --- a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java +++ b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java @@ -31,7 +31,6 @@ import java.util.stream.Collectors; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; -import software.amazon.lambda.powertools.parameters.ParamManager; import software.amazon.lambda.powertools.parameters.secrets.SecretsParam; import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.ssm.SSMParam; diff --git a/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java b/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java index 5478931f1..29508bc2f 100644 --- a/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java +++ b/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java @@ -65,6 +65,7 @@ public Object process(ProceedingJoinPoint pjp, boolean deleteS3Object) throws Th String s3ObjectContent = getS3ObjectContent(payloadPointer); + if (LOG.isDebugEnabled()) { LOG.debug("Large message [{}] retrieved in S3 [{}]: {}KB", getMessageId(message), payloadPointer, s3ObjectContent.getBytes(StandardCharsets.UTF_8).length / 1024); diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index 636242715..dec439302 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -14,6 +14,7 @@ package software.amazon.lambda.powertools.parameters.appconfig; +import java.util.function.BiFunction; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; @@ -23,6 +24,12 @@ @Aspect public class AppConfigParametersAspect { + private static BiFunction providerBuilder = + (String env, String app) -> AppConfigProvider.builder() + .withEnvironment(env) + .withApplication(app) + .build(); + @Pointcut("get(* *) && @annotation(appConfigParamAnnotation)") public void getParam(AppConfigParam appConfigParamAnnotation) { @@ -32,10 +39,8 @@ public void getParam(AppConfigParam appConfigParamAnnotation) { public Object injectParam(final ProceedingJoinPoint joinPoint, final AppConfigParam appConfigParamAnnotation) { System.out.println("GET IT"); - AppConfigProvider provider = AppConfigProvider.builder() - .withEnvironment(appConfigParamAnnotation.environment()) - .withApplication(appConfigParamAnnotation.application()) - .build(); + AppConfigProvider provider = providerBuilder.apply + (appConfigParamAnnotation.environment(), appConfigParamAnnotation.application()); if (appConfigParamAnnotation.transformer().isInterface()) { // No transformation diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java index 027f828a3..596a2b917 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java @@ -16,17 +16,12 @@ import java.util.HashMap; import java.util.Map; -import software.amazon.awssdk.core.SdkSystemSetting; -import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; -import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; -import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; -import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationRequest; import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationResponse; import software.amazon.awssdk.services.appconfigdata.model.StartConfigurationSessionRequest; -import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -51,8 +46,8 @@ public class AppConfigProvider extends BaseProvider { private final String environment; private final HashMap establishedSessions = new HashMap<>(); - AppConfigProvider(CacheManager cacheManager, AppConfigDataClient client, String environment, String application) { - super(cacheManager); + AppConfigProvider(CacheManager cacheManager, TransformationManager transformationManager, AppConfigDataClient client, String environment, String application) { + super(cacheManager, transformationManager); this.client = client; this.application = application; this.environment = environment; @@ -61,10 +56,10 @@ public class AppConfigProvider extends BaseProvider { /** * Create a builder that can be used to configure and create a {@link AppConfigProvider}. * - * @return a new instance of {@link AppConfigProvider.Builder} + * @return a new instance of {@link AppConfigProviderBuilder} */ - public static AppConfigProvider.Builder builder() { - return new AppConfigProvider.Builder(); + public static AppConfigProviderBuilder builder() { + return new AppConfigProviderBuilder(); } /** @@ -129,102 +124,4 @@ private EstablishedSession(String nextSessionToken, String value) { } } - static class Builder { - private AppConfigDataClient client; - private CacheManager cacheManager; - private TransformationManager transformationManager; - private String environment; - private String application; - - /** - * Create a {@link AppConfigProvider} instance. - * - * @return a {@link AppConfigProvider} - */ - public AppConfigProvider build() { - if (cacheManager == null) { - cacheManager = new CacheManager(); - } - if (environment == null) { - throw new IllegalStateException("No environment provided; please provide one"); - } - if (application == null) { - throw new IllegalStateException("No application provided; please provide one"); - } - - // Create a AppConfigDataClient if we haven't been given one - if (client == null) { - client = AppConfigDataClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) - .overrideConfiguration(ClientOverrideConfiguration.builder() - .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) - .build(); - } - - AppConfigProvider provider = new AppConfigProvider(cacheManager, client, environment, application); - - if (transformationManager != null) { - provider.setTransformationManager(transformationManager); - } - return provider; - } - - /** - * Set custom {@link AppConfigProvider} to pass to the {@link AppConfigDataClient}.
- * Use it if you want to customize the region or any other part of the client. - * - * @param client Custom client - * @return the builder to chain calls (eg. 
builder.withClient().build()
) - */ - public AppConfigProvider.Builder withClient(AppConfigDataClient client) { - this.client = client; - return this; - } - - /** - * Mandatory. Provide an environment to the {@link AppConfigProvider} - * - * @param environment the AppConfig environment - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public AppConfigProvider.Builder withEnvironment(String environment) { - this.environment = environment; - return this; - } - - /** - * Mandatory. Provide an application to the {@link AppConfigProvider} - * - * @param application the application to pull configuration from - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public AppConfigProvider.Builder withApplication(String application) { - this.application = application; - return this; - } - - /** - * Mandatory. Provide a CacheManager to the {@link AppConfigProvider} - * - * @param cacheManager the manager that will handle the cache of parameters - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public AppConfigProvider.Builder withCacheManager(CacheManager cacheManager) { - this.cacheManager = cacheManager; - return this; - } - - /** - * Provide a transformationManager to the {@link AppConfigProvider} - * - * @param transformationManager the manager that will handle transformation of parameters - * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) - */ - public AppConfigProvider.Builder withTransformationManager(TransformationManager transformationManager) { - this.transformationManager = transformationManager; - return this; - } - } } diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java new file mode 100644 index 000000000..789ef2701 --- /dev/null +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java @@ -0,0 +1,106 @@ +package software.amazon.lambda.powertools.parameters.appconfig; + +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; +import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + +public class AppConfigProviderBuilder { + private AppConfigDataClient client; + private CacheManager cacheManager; + private TransformationManager transformationManager; + private String environment; + private String application; + + /** + * Create a {@link AppConfigProvider} instance. + * + * @return a {@link AppConfigProvider} + */ + public AppConfigProvider build() { + if (cacheManager == null) { + cacheManager = new CacheManager(); + } + if (environment == null) { + throw new IllegalStateException("No environment provided; please provide one"); + } + if (application == null) { + throw new IllegalStateException("No application provided; please provide one"); + } + + // Create a AppConfigDataClient if we haven't been given one + if (client == null) { + client = AppConfigDataClient.builder() + .httpClientBuilder(UrlConnectionHttpClient.builder()) + .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) + .overrideConfiguration(ClientOverrideConfiguration.builder() + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) + .build(); + } + + return new AppConfigProvider(cacheManager, transformationManager, client, environment, application); + } + + /** + * Set custom {@link AppConfigProvider} to pass to the {@link AppConfigDataClient}.
+ * Use it if you want to customize the region or any other part of the client. + * + * @param client Custom client + * @return the builder to chain calls (eg. 
builder.withClient().build()
) + */ + public AppConfigProviderBuilder withClient(AppConfigDataClient client) { + this.client = client; + return this; + } + + /** + * Mandatory. Provide an environment to the {@link AppConfigProvider} + * + * @param environment the AppConfig environment + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public AppConfigProviderBuilder withEnvironment(String environment) { + this.environment = environment; + return this; + } + + /** + * Mandatory. Provide an application to the {@link AppConfigProvider} + * + * @param application the application to pull configuration from + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public AppConfigProviderBuilder withApplication(String application) { + this.application = application; + return this; + } + + /** + * Mandatory. Provide a CacheManager to the {@link AppConfigProvider} + * + * @param cacheManager the manager that will handle the cache of parameters + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public AppConfigProviderBuilder withCacheManager(CacheManager cacheManager) { + this.cacheManager = cacheManager; + return this; + } + + /** + * Provide a transformationManager to the {@link AppConfigProvider} + * + * @param transformationManager the manager that will handle transformation of parameters + * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) + */ + public AppConfigProviderBuilder withTransformationManager(TransformationManager transformationManager) { + this.transformationManager = transformationManager; + return this; + } +} diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java index 2337c4c9d..f38e67f0e 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java @@ -1,15 +1,41 @@ package software.amazon.lambda.powertools.parameters.appconfig; -// TODO - what can we do with this? We need a way to inject a different -// AppConfigDataClient in -//public class AppConfigParamAspectTest { -// -// @AppConfigParam(application = "myApp", environment = "myEnvironment", key = "myKey") -// public String myParameter; -// -// @Test -// public void parameterInjectedByProvider() { -// assertThat(myParameter); -// } -// -//} +import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.function.BiFunction; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +public class AppConfigParamAspectTest { + + @Test + public void parameterInjectedByProvider() throws Exception { + // Setup our aspect to return a mocked AppConfigProvider + String environment = "myEnvironment"; + String appName = "myApp"; + String key = "myKey"; + String value = "myValue"; + AppConfigProvider provider = Mockito.mock(AppConfigProvider.class); + BiFunction providerBuilder = (String env, String app) -> { + if (env.equals(environment) && app.equals(appName)) { + return provider; + } + throw new RuntimeException("Whoops! Asked for an app/env that we weren't configured for"); + }; + writeStaticField(AppConfigParametersAspect.class, "providerBuilder", providerBuilder, true); + + // Setup our mocked AppConfigProvider to return a value for our test data + Mockito.when(provider.get(key)).thenReturn(value); + + // Create an instance of a class and let the AppConfigParametersAspect inject it + MyInjectedClass obj = new MyInjectedClass(); + assertThat(obj.myParameter).isEqualTo(value); + } + + class MyInjectedClass { + @AppConfigParam(application = "myApp", environment = "myEnvironment", key = "myKey") + public String myParameter; + } + +} diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java deleted file mode 100644 index ad7dbf6db..000000000 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/Builder.java +++ /dev/null @@ -1,2 +0,0 @@ -package software.amazon.lambda.powertools.parameters.dynamodb;public class Builder { -} diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index b665b1e35..5df1c7e58 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -17,18 +17,12 @@ import java.util.Collections; import java.util.Map; import java.util.stream.Collectors; -import software.amazon.awssdk.core.SdkSystemSetting; -import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; -import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; -import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; -import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.dynamodb.model.AttributeValue; import software.amazon.awssdk.services.dynamodb.model.GetItemRequest; import software.amazon.awssdk.services.dynamodb.model.GetItemResponse; import software.amazon.awssdk.services.dynamodb.model.QueryRequest; import software.amazon.awssdk.services.dynamodb.model.QueryResponse; -import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; @@ -46,23 +40,19 @@ public class DynamoDbProvider extends BaseProvider { private final DynamoDbClient client; private final String tableName; - DynamoDbProvider(CacheManager cacheManager, DynamoDbClient client, String tableName) { - super(cacheManager); + DynamoDbProvider(CacheManager cacheManager, TransformationManager transformationManager, DynamoDbClient client, String tableName) { + super(cacheManager, transformationManager); this.client = client; this.tableName = tableName; } - DynamoDbProvider(CacheManager cacheManager, String tableName) { - this(cacheManager, Builder.createClient(), tableName); - } - /** * Create a builder that can be used to configure and create a {@link DynamoDbProvider}. * - * @return a new instance of {@link DynamoDbProvider.Builder} + * @return a new instance of {@link DynamoDbProviderBuilder} */ - public static DynamoDbProvider.Builder builder() { - return new DynamoDbProvider.Builder(); + public static DynamoDbProviderBuilder builder() { + return new DynamoDbProviderBuilder(); } /** @@ -127,89 +117,4 @@ protected Map getMultipleValues(String path) { } - static class Builder { - private DynamoDbClient client; - private String table; - private CacheManager cacheManager; - private TransformationManager transformationManager; - - private static DynamoDbClient createClient() { - return DynamoDbClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) - .overrideConfiguration(ClientOverrideConfiguration.builder() - .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(PARAMETERS)).build()) - .build(); - } - - /** - * Create a {@link DynamoDbProvider} instance. - * - * @return a {@link DynamoDbProvider} - */ - public DynamoDbProvider build() { - if (cacheManager == null) { - cacheManager = new CacheManager(); - } - if (table == null) { - throw new IllegalStateException("No DynamoDB table name provided; please provide one"); - } - DynamoDbProvider provider; - if (client == null) { - client = createClient(); - } - provider = new DynamoDbProvider(cacheManager, client, table); - - if (transformationManager != null) { - provider.setTransformationManager(transformationManager); - } - return provider; - } - - /** - * Set custom {@link DynamoDbClient} to pass to the {@link DynamoDbClient}.
- * Use it if you want to customize the region or any other part of the client. - * - * @param client Custom client - * @return the builder to chain calls (eg. 
builder.withClient().build()
) - */ - public DynamoDbProvider.Builder withClient(DynamoDbClient client) { - this.client = client; - return this; - } - - /** - * Mandatory. Provide a CacheManager to the {@link DynamoDbProvider} - * - * @param cacheManager the manager that will handle the cache of parameters - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public DynamoDbProvider.Builder withCacheManager(CacheManager cacheManager) { - this.cacheManager = cacheManager; - return this; - } - - /** - * Mandatory. Provide a DynamoDB table to the {@link DynamoDbProvider} - * - * @param table the table that parameters will be retrieved from. - * @return the builder to chain calls (eg. 
builder.withTable().build()
) - */ - public DynamoDbProvider.Builder withTable(String table) { - this.table = table; - return this; - } - - /** - * Provide a transformationManager to the {@link DynamoDbProvider} - * - * @param transformationManager the manager that will handle transformation of parameters - * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) - */ - public DynamoDbProvider.Builder withTransformationManager(TransformationManager transformationManager) { - this.transformationManager = transformationManager; - return this; - } - } } diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java new file mode 100644 index 000000000..a3632fac2 --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -0,0 +1,95 @@ +package software.amazon.lambda.powertools.parameters.dynamodb; + +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.dynamodb.DynamoDbClient; +import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + +class DynamoDbProviderBuilder { + private DynamoDbClient client; + private String table; + private CacheManager cacheManager; + private TransformationManager transformationManager; + + static DynamoDbClient createClient() { + return DynamoDbClient.builder() + .httpClientBuilder(UrlConnectionHttpClient.builder()) + .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) + .overrideConfiguration(ClientOverrideConfiguration.builder() + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) + .build(); + } + + /** + * Create a {@link DynamoDbProvider} instance. + * + * @return a {@link DynamoDbProvider} + */ + public DynamoDbProvider build() { + if (cacheManager == null) { + cacheManager = new CacheManager(); + } + if (table == null) { + throw new IllegalStateException("No DynamoDB table name provided; please provide one"); + } + DynamoDbProvider provider; + if (client == null) { + client = createClient(); + } + provider = new DynamoDbProvider(cacheManager, transformationManager, client, table); + + return provider; + } + + /** + * Set custom {@link DynamoDbClient} to pass to the {@link DynamoDbClient}.
+ * Use it if you want to customize the region or any other part of the client. + * + * @param client Custom client + * @return the builder to chain calls (eg. 
builder.withClient().build()
) + */ + public DynamoDbProviderBuilder withClient(DynamoDbClient client) { + this.client = client; + return this; + } + + /** + * Mandatory. Provide a CacheManager to the {@link DynamoDbProvider} + * + * @param cacheManager the manager that will handle the cache of parameters + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public DynamoDbProviderBuilder withCacheManager(CacheManager cacheManager) { + this.cacheManager = cacheManager; + return this; + } + + /** + * Mandatory. Provide a DynamoDB table to the {@link DynamoDbProvider} + * + * @param table the table that parameters will be retrieved from. + * @return the builder to chain calls (eg. 
builder.withTable().build()
) + */ + public DynamoDbProviderBuilder withTable(String table) { + this.table = table; + return this; + } + + /** + * Provide a transformationManager to the {@link DynamoDbProvider} + * + * @param transformationManager the manager that will handle transformation of parameters + * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) + */ + public DynamoDbProviderBuilder withTransformationManager(TransformationManager transformationManager) { + this.transformationManager = transformationManager; + return this; + } +} diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java index c7530e1b7..2695938d8 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderE2ETest.java @@ -104,7 +104,7 @@ public void TestGetValues() { } private DynamoDbProvider makeProvider(String tableName) { - return new DynamoDbProvider(new CacheManager(), DynamoDbClient.builder() + return new DynamoDbProvider(new CacheManager(), null, DynamoDbClient.builder() .httpClientBuilder(UrlConnectionHttpClient.builder()).build(), tableName); } diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java index 0d0fbd2d9..68bfd7cdb 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderTest.java @@ -55,7 +55,7 @@ public class DynamoDbProviderTest { public void init() { openMocks(this); CacheManager cacheManager = new CacheManager(); - provider = new DynamoDbProvider(cacheManager, client, tableName); + provider = new DynamoDbProvider(cacheManager, transformationManager, client, tableName); } diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index 326c5ef36..c7a9f3fac 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -19,14 +19,8 @@ import java.time.temporal.ChronoUnit; import java.util.Base64; import java.util.Map; -import software.amazon.awssdk.core.SdkSystemSetting; -import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; -import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; -import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; -import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.awssdk.services.secretsmanager.model.GetSecretValueRequest; -import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -64,33 +58,22 @@ public class SecretsProvider extends BaseProvider { * Constructor with custom {@link SecretsManagerClient}.
* Use when you need to customize region or any other attribute of the client.

*

- * Use the {@link Builder} to create an instance of it. + * Use the {@link SecretsProviderBuilder} to create an instance of it. * * @param client custom client you would like to use. */ - public SecretsProvider(CacheManager cacheManager, SecretsManagerClient client) { - super(cacheManager); + public SecretsProvider(CacheManager cacheManager, TransformationManager transformationManager, SecretsManagerClient client) { + super(cacheManager, transformationManager); this.client = client; } - /** - * Constructor with only a CacheManager
- *

- * Used in {@link ParamManager#createProvider(Class)} - * - * @param cacheManager handles the parameter caching - */ - public SecretsProvider(CacheManager cacheManager) { - this(cacheManager, Builder.createClient()); - } - /** * Create a builder that can be used to configure and create a {@link SecretsProvider}. * - * @return a new instance of {@link SecretsProvider.Builder} + * @return a new instance of {@link SecretsProviderBuilder} */ - public static Builder builder() { - return new Builder(); + public static SecretsProviderBuilder builder() { + return new SecretsProviderBuilder(); } /** @@ -152,77 +135,4 @@ SecretsManagerClient getClient() { return client; } - public static class Builder { - - private SecretsManagerClient client; - private CacheManager cacheManager; - private TransformationManager transformationManager; - - private static SecretsManagerClient createClient() { - return SecretsManagerClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) - .overrideConfiguration(ClientOverrideConfiguration.builder() - .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) - .build(); - } - - /** - * Create a {@link SecretsProvider} instance. - * - * @return a {@link SecretsProvider} - */ - public SecretsProvider build() { - if (cacheManager == null) { - // TODO - what should we do with this - cacheManager = new CacheManager(); - } - SecretsProvider provider; - if (client == null) { - client = createClient(); - } - - provider = new SecretsProvider(cacheManager, client); - - if (transformationManager != null) { - provider.setTransformationManager(transformationManager); - } - return provider; - } - - /** - * Set custom {@link SecretsManagerClient} to pass to the {@link SecretsProvider}.
- * Use it if you want to customize the region or any other part of the client. - * - * @param client Custom client - * @return the builder to chain calls (eg. 

builder.withClient().build()
) - */ - public Builder withClient(SecretsManagerClient client) { - this.client = client; - return this; - } - - /** - * Mandatory. Provide a CacheManager to the {@link SecretsProvider} - * - * @param cacheManager the manager that will handle the cache of parameters - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public Builder withCacheManager(CacheManager cacheManager) { - this.cacheManager = cacheManager; - return this; - } - - /** - * Provide a transformationManager to the {@link SecretsProvider} - * - * @param transformationManager the manager that will handle transformation of parameters - * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) - */ - public Builder withTransformationManager(TransformationManager transformationManager) { - this.transformationManager = transformationManager; - return this; - } - } } diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java new file mode 100644 index 000000000..50358a16e --- /dev/null +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java @@ -0,0 +1,83 @@ +package software.amazon.lambda.powertools.parameters.secrets; + +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; +import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + +public class SecretsProviderBuilder { + + private SecretsManagerClient client; + private CacheManager cacheManager; + private TransformationManager transformationManager; + + private static SecretsManagerClient createClient() { + return SecretsManagerClient.builder() + .httpClientBuilder(UrlConnectionHttpClient.builder()) + .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) + .overrideConfiguration(ClientOverrideConfiguration.builder() + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) + .build(); + } + + /** + * Create a {@link SecretsProvider} instance. + * + * @return a {@link SecretsProvider} + */ + public SecretsProvider build() { + if (cacheManager == null) { + // TODO - what should we do with this + cacheManager = new CacheManager(); + } + SecretsProvider provider; + if (client == null) { + client = createClient(); + } + + provider = new SecretsProvider(cacheManager, transformationManager, client); + + return provider; + } + + /** + * Set custom {@link SecretsManagerClient} to pass to the {@link SecretsProvider}.
+ * Use it if you want to customize the region or any other part of the client. + * + * @param client Custom client + * @return the builder to chain calls (eg. 
builder.withClient().build()
) + */ + public SecretsProviderBuilder withClient(SecretsManagerClient client) { + this.client = client; + return this; + } + + /** + * Mandatory. Provide a CacheManager to the {@link SecretsProvider} + * + * @param cacheManager the manager that will handle the cache of parameters + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public SecretsProviderBuilder withCacheManager(CacheManager cacheManager) { + this.cacheManager = cacheManager; + return this; + } + + /** + * Provide a transformationManager to the {@link SecretsProvider} + * + * @param transformationManager the manager that will handle transformation of parameters + * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) + */ + public SecretsProviderBuilder withTransformationManager(TransformationManager transformationManager) { + this.transformationManager = transformationManager; + return this; + } +} diff --git a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java index 1b4cc4306..2e0de7cf3 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java +++ b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java @@ -56,7 +56,7 @@ public class SecretsProviderTest { public void init() { MockitoAnnotations.openMocks(this); cacheManager = new CacheManager(); - provider = new SecretsProvider(cacheManager, client); + provider = new SecretsProvider(cacheManager, transformationManager, client); } @Test diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java index a21821009..43cf18653 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java @@ -17,17 +17,11 @@ import java.time.temporal.ChronoUnit; import java.util.HashMap; import java.util.Map; -import software.amazon.awssdk.core.SdkSystemSetting; -import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; -import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; -import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; -import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.awssdk.services.ssm.model.GetParameterRequest; import software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest; import software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse; import software.amazon.awssdk.utils.StringUtils; -import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; @@ -81,22 +75,23 @@ public class SSMProvider extends BaseProvider { * Constructor with custom {@link SsmClient}.
* Use when you need to customize region or any other attribute of the client.

*

- * Use the {@link SSMProvider.Builder} to create an instance of it. + * Use the {@link SSMProviderBuilder} to create an instance of it. * * @param client custom client you would like to use. + * @param transformationManager Null, or a transformation manager */ - SSMProvider(CacheManager cacheManager, SsmClient client) { - super(cacheManager); + SSMProvider(CacheManager cacheManager, TransformationManager transformationManager, SsmClient client) { + super(cacheManager, transformationManager); this.client = client; } /** * Create a builder that can be used to configure and create a {@link SSMProvider}. * - * @return a new instance of {@link SSMProvider.Builder} + * @return a new instance of {@link SSMProviderBuilder} */ - public static SSMProvider.Builder builder() { - return new SSMProvider.Builder(); + public static SSMProviderBuilder builder() { + return new SSMProviderBuilder(); } /** @@ -232,76 +227,4 @@ SsmClient getClient() { return client; } - public static class Builder { - private SsmClient client; - private CacheManager cacheManager; - private TransformationManager transformationManager; - - private static SsmClient createClient() { - return SsmClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) - .overrideConfiguration(ClientOverrideConfiguration.builder() - .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, - UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) - .build(); - } - - /** - * Create a {@link SSMProvider} instance. - * - * @return a {@link SSMProvider} - */ - public SSMProvider build() { - if (cacheManager == null) { - // TODO - do we want to share this somehow? - cacheManager = new CacheManager(); - } - SSMProvider provider; - if (client == null) { - client = createClient(); - } - - provider = new SSMProvider(cacheManager, client); - - if (transformationManager != null) { - provider.setTransformationManager(transformationManager); - } - return provider; - } - - /** - * Set custom {@link SsmClient} to pass to the {@link SSMProvider}.
- * Use it if you want to customize the region or any other part of the client. - * - * @param client Custom client - * @return the builder to chain calls (eg. 

builder.withClient().build()
) - */ - public SSMProvider.Builder withClient(SsmClient client) { - this.client = client; - return this; - } - - /** - * Mandatory. Provide a CacheManager to the {@link SSMProvider} - * - * @param cacheManager the manager that will handle the cache of parameters - * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) - */ - public SSMProvider.Builder withCacheManager(CacheManager cacheManager) { - this.cacheManager = cacheManager; - return this; - } - - /** - * Provide a transformationManager to the {@link SSMProvider} - * - * @param transformationManager the manager that will handle transformation of parameters - * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) - */ - public SSMProvider.Builder withTransformationManager(TransformationManager transformationManager) { - this.transformationManager = transformationManager; - return this; - } - } } diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java new file mode 100644 index 000000000..717167bb4 --- /dev/null +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java @@ -0,0 +1,82 @@ +package software.amazon.lambda.powertools.parameters.ssm; + +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.ssm.SsmClient; +import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; +import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.cache.CacheManager; +import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + +public class SSMProviderBuilder { + private SsmClient client; + private CacheManager cacheManager; + private TransformationManager transformationManager; + + private static SsmClient createClient() { + return SsmClient.builder() + .httpClientBuilder(UrlConnectionHttpClient.builder()) + .region(Region.of(System.getenv(SdkSystemSetting.AWS_REGION.environmentVariable()))) + .overrideConfiguration(ClientOverrideConfiguration.builder() + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, + UserAgentConfigurator.getUserAgent(BaseProvider.PARAMETERS)).build()) + .build(); + } + + /** + * Create a {@link SSMProvider} instance. + * + * @return a {@link SSMProvider} + */ + public SSMProvider build() { + if (cacheManager == null) { + // TODO - do we want to share this somehow? + cacheManager = new CacheManager(); + } + SSMProvider provider; + if (client == null) { + client = createClient(); + } + + provider = new SSMProvider(cacheManager, transformationManager, client); + + return provider; + } + + /** + * Set custom {@link SsmClient} to pass to the {@link SSMProvider}.
+ * Use it if you want to customize the region or any other part of the client. + * + * @param client Custom client + * @return the builder to chain calls (eg. 
builder.withClient().build()
) + */ + public SSMProviderBuilder withClient(SsmClient client) { + this.client = client; + return this; + } + + /** + * Mandatory. Provide a CacheManager to the {@link SSMProvider} + * + * @param cacheManager the manager that will handle the cache of parameters + * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) + */ + public SSMProviderBuilder withCacheManager(CacheManager cacheManager) { + this.cacheManager = cacheManager; + return this; + } + + /** + * Provide a transformationManager to the {@link SSMProvider} + * + * @param transformationManager the manager that will handle transformation of parameters + * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) + */ + public SSMProviderBuilder withTransformationManager(TransformationManager transformationManager) { + this.transformationManager = transformationManager; + return this; + } +} diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index bdbc97f7c..4814ebe1f 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -62,7 +62,7 @@ public class SSMProviderTest { public void init() { MockitoAnnotations.openMocks(this); cacheManager = new CacheManager(); - provider = new SSMProvider(cacheManager, client); + provider = new SSMProvider(cacheManager, null, client); } @Test diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java index edc671e2c..0d9f71ab5 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java @@ -53,7 +53,6 @@ public void setup() { cacheManager = new CacheManager(); provider = new BasicProvider(cacheManager); transformationManager = new TransformationManager(); - provider.setTransformationManager(transformationManager); } @Test @@ -335,7 +334,6 @@ public void getObject_customDefaultTTLAndTTL_expired_shouldGetValue() { @Test public void get_noTransformationManager_shouldThrowException() { - provider.setTransformationManager(null); assertThatIllegalStateException() .isThrownBy(() -> provider.withTransformation(base64).get("foo")); @@ -343,7 +341,6 @@ public void get_noTransformationManager_shouldThrowException() { @Test public void getObject_noTransformationManager_shouldThrowException() { - provider.setTransformationManager(null); assertThatIllegalStateException() .isThrownBy(() -> provider.get("foo", ObjectToDeserialize.class)); @@ -380,7 +377,7 @@ class BasicProvider extends BaseProvider { private String value = "valueFromStore"; public BasicProvider(CacheManager cacheManager) { - super(cacheManager); + super(cacheManager, null); } public void setValue(String value) { diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java deleted file mode 100644 index 5c213a328..000000000 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerTest.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * Copyright 2023 Amazon.com, Inc. or its affiliates. - * Licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License 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.lambda.powertools.parameters; - -import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; -import static org.assertj.core.api.Assertions.assertThatIllegalStateException; -import static org.assertj.core.api.Assertions.assertThatRuntimeException; -import static org.junit.jupiter.api.Assertions.assertNotNull; - -import org.junit.jupiter.api.Test; -import software.amazon.lambda.powertools.parameters.cache.CacheManager; -import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProvider; -import software.amazon.lambda.powertools.parameters.internal.CustomProvider; -import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; -import software.amazon.lambda.powertools.parameters.transform.TransformationManager; - -public class ParamManagerTest { - - @Test - public void testGetCacheManager() { - - // Act - CacheManager cacheManager = ParamManager.getCacheManager(); - - // Assert - assertNotNull(cacheManager); - } - - @Test - public void testGetTransformationManager() { - - // Act - TransformationManager transformationManager = ParamManager.getTransformationManager(); - - // Assert - assertNotNull(transformationManager); - } - -// @Test -// public void testCreateProvider() { -// - // Act -// CustomProvider customProvider = ParamManager.createProvider(CustomProvider.class); -// -// // Assert -// assertNotNull(customProvider); -// } -// -// @Test -// public void testCreateUninstanciableProvider_throwsException() { -// -// // Act & Assert -// assertThatRuntimeException().isThrownBy(() -> ParamManager.createProvider(BaseProvider.class)); -// } -// -// @Test -// public void testGetProviderWithProviderClass() { -// -// // Act -// SecretsProvider secretsProvider = ParamManager.getProvider(SecretsProvider.class); -// -// // Assert -// assertNotNull(secretsProvider); -// } -// -// @Test -// public void testGetProviderWithProviderClass_throwsException() { -// -// // Act & Assert -// assertThatIllegalStateException().isThrownBy(() -> ParamManager.getProvider(null)); -// } -// -// -// @Test -// public void testGetDynamoDBProvider_requireOtherParameters_throwException() { -// -// // Act & Assert -// assertThatIllegalArgumentException().isThrownBy(() -> ParamManager.getProvider(DynamoDbProvider.class)); -// } - -} diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java index 2c9db3712..a98d68c22 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/internal/CustomProvider.java @@ -25,7 +25,7 @@ public class CustomProvider extends BaseProvider { private final Map values = new HashMap<>(); public CustomProvider(CacheManager cacheManager) { - super(cacheManager); + super(cacheManager, null); values.put("/simple", "value"); values.put("/base64", Base64.getEncoder().encodeToString("value".getBytes())); values.put("/json", "{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java index edb82f5ec..0afed3413 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java @@ -34,11 +34,12 @@ public abstract class BaseProvider implements ParamProvider { public static final String PARAMETERS = "parameters"; protected final CacheManager cacheManager; - private TransformationManager transformationManager; + private final TransformationManager transformationManager; private Clock clock; - public BaseProvider(CacheManager cacheManager) { + public BaseProvider(CacheManager cacheManager, TransformationManager transformationManager) { this.cacheManager = cacheManager; + this.transformationManager = transformationManager; } /** @@ -225,10 +226,6 @@ protected void resetToDefaults() { } } - protected void setTransformationManager(TransformationManager transformationManager) { - this.transformationManager = transformationManager; - } - /** * For test purpose * diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java deleted file mode 100644 index 79eb796e8..000000000 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/ParamManager.java +++ /dev/null @@ -1,38 +0,0 @@ -/* - * Copyright 2023 Amazon.com, Inc. or its affiliates. - * Licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License 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.lambda.powertools.parameters; - -import software.amazon.lambda.powertools.parameters.cache.CacheManager; -import software.amazon.lambda.powertools.parameters.transform.TransformationManager; - -/** - * Utility class to retrieve instances of parameter providers. - * Each instance is unique (singleton). - */ -public final class ParamManager { - - private static final CacheManager cacheManager = new CacheManager(); - private static final TransformationManager transformationManager = new TransformationManager(); - - public static CacheManager getCacheManager() { - return cacheManager; - } - - public static TransformationManager getTransformationManager() { - return transformationManager; - } - - -} From aaba843dad3773a18f55dadf8214b71edc2c5580 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Mon, 18 Sep 2023 20:16:23 +0200 Subject: [PATCH 13/45] Build fix? --- .../appconfig/AppConfigProviderBuilder.java | 14 ++++++ .../dynamodb/DynamoDbProviderBuilder.java | 14 ++++++ .../parameters/secrets/SecretsProvider.java | 7 +-- .../secrets/SecretsProviderBuilder.java | 14 ++++++ .../parameters/ssm/SSMProviderBuilder.java | 14 ++++++ powertools-parameters/spotbugs-exclude.xml | 46 ++++++++++++++++++- spotbugs-exclude.xml | 34 ++++++++++++++ 7 files changed, 137 insertions(+), 6 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java index 789ef2701..38df99c4e 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.appconfig; import software.amazon.awssdk.core.SdkSystemSetting; diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index a3632fac2..dd81b6469 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.dynamodb; import software.amazon.awssdk.core.SdkSystemSetting; diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index c7a9f3fac..3e54a82e8 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -55,14 +55,11 @@ public class SecretsProvider extends BaseProvider { private final SecretsManagerClient client; /** - * Constructor with custom {@link SecretsManagerClient}.
- * Use when you need to customize region or any other attribute of the client.

- *

- * Use the {@link SecretsProviderBuilder} to create an instance of it. + * Use the {@link SecretsProviderBuilder} to create an instance! * * @param client custom client you would like to use. */ - public SecretsProvider(CacheManager cacheManager, TransformationManager transformationManager, SecretsManagerClient client) { + SecretsProvider(CacheManager cacheManager, TransformationManager transformationManager, SecretsManagerClient client) { super(cacheManager, transformationManager); this.client = client; } diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java index 50358a16e..3b13d0c37 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.secrets; import software.amazon.awssdk.core.SdkSystemSetting; diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java index 717167bb4..59616e385 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.ssm; import software.amazon.awssdk.core.SdkSystemSetting; diff --git a/powertools-parameters/spotbugs-exclude.xml b/powertools-parameters/spotbugs-exclude.xml index 98536870b..a7f4e4d8c 100644 --- a/powertools-parameters/spotbugs-exclude.xml +++ b/powertools-parameters/spotbugs-exclude.xml @@ -15,9 +15,53 @@ + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml index fd1ef6f44..dc22f22b6 100644 --- a/spotbugs-exclude.xml +++ b/spotbugs-exclude.xml @@ -8,6 +8,40 @@ https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 0cd48da76fea843d147346bf77861c9825ef10fb Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Mon, 18 Sep 2023 20:23:35 +0200 Subject: [PATCH 14/45] Fix test --- .../lambda/powertools/parameters/BaseProviderTest.java | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java index 0d9f71ab5..a4cdd85af 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java @@ -51,8 +51,8 @@ public void setup() { clock = Clock.systemDefaultZone(); cacheManager = new CacheManager(); - provider = new BasicProvider(cacheManager); transformationManager = new TransformationManager(); + provider = new BasicProvider(cacheManager, transformationManager); } @Test @@ -303,7 +303,6 @@ public void getObject_customDefaultTTL_expired_shouldGetValue() { @Test public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.defaultMaxAge(12, ChronoUnit.MINUTES) .withMaxAge(5, SECONDS) .withTransformation(json) @@ -334,6 +333,7 @@ public void getObject_customDefaultTTLAndTTL_expired_shouldGetValue() { @Test public void get_noTransformationManager_shouldThrowException() { + provider = new BasicProvider(new CacheManager(), null); assertThatIllegalStateException() .isThrownBy(() -> provider.withTransformation(base64).get("foo")); @@ -376,8 +376,8 @@ class BasicProvider extends BaseProvider { private String value = "valueFromStore"; - public BasicProvider(CacheManager cacheManager) { - super(cacheManager, null); + public BasicProvider(CacheManager cacheManager, TransformationManager transformationManager) { + super(cacheManager, transformationManager); } public void setValue(String value) { From 4b898626bf7d64687dce37763928e59ef0521688 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Mon, 18 Sep 2023 20:29:02 +0200 Subject: [PATCH 15/45] Remove gradle noise --- .../gradle/.gradle/7.3.3/checksums/checksums.lock | Bin 17 -> 0 bytes .../.gradle/7.3.3/fileChanges/last-build.bin | Bin 1 -> 0 bytes .../.gradle/7.3.3/fileHashes/fileHashes.lock | Bin 17 -> 0 bytes .../gradle/.gradle/7.3.3/gc.properties | 0 .../gradle/.gradle/vcs-1/gc.properties | 0 .../gradle/.gradle/7.3.3/checksums/checksums.lock | Bin 17 -> 0 bytes .../.gradle/7.3.3/fileChanges/last-build.bin | Bin 1 -> 0 bytes .../.gradle/7.3.3/fileHashes/fileHashes.lock | Bin 17 -> 0 bytes .../gradle/.gradle/7.3.3/gc.properties | 0 .../gradle/.gradle/vcs-1/gc.properties | 0 10 files changed, 0 insertions(+), 0 deletions(-) delete mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock delete mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin delete mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock delete mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties delete mode 100644 examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties delete mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock delete mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin delete mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock delete mode 100644 examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties delete mode 100644 examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/checksums/checksums.lock deleted file mode 100644 index 137f02edd07205014ea750fc7f5af43c8b21b0d3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17 TcmZQR;rp-S!lD1O8K3|FN0J50 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileChanges/last-build.bin deleted file mode 100644 index f76dd238ade08917e6712764a16a22005a50573d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1 IcmZPo000310RR91 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock deleted file mode 100644 index d2358784bf82bce372f41c1be1b805984af62bf7..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17 TcmZSPKFMA;$xm%90~7!NB}M}f diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties b/examples/powertools-examples-core-utilities/gradle/.gradle/7.3.3/gc.properties deleted file mode 100644 index e69de29bb..000000000 diff --git a/examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties b/examples/powertools-examples-core-utilities/gradle/.gradle/vcs-1/gc.properties deleted file mode 100644 index e69de29bb..000000000 diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock b/examples/powertools-examples-core/gradle/.gradle/7.3.3/checksums/checksums.lock deleted file mode 100644 index ab02aac0d7cc045b38c939b191240bf8d3f2af7b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17 TcmZS1{PFajnc1pM3{U_7KIjDS diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin b/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileChanges/last-build.bin deleted file mode 100644 index f76dd238ade08917e6712764a16a22005a50573d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1 IcmZPo000310RR91 diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock b/examples/powertools-examples-core/gradle/.gradle/7.3.3/fileHashes/fileHashes.lock deleted file mode 100644 index d082a98bc5aa56290fd95d661efc99fba8107d56..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17 ScmZSH5|xnB;%B#w0SW*udIOvQ diff --git a/examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties b/examples/powertools-examples-core/gradle/.gradle/7.3.3/gc.properties deleted file mode 100644 index e69de29bb..000000000 diff --git a/examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties b/examples/powertools-examples-core/gradle/.gradle/vcs-1/gc.properties deleted file mode 100644 index e69de29bb..000000000 From 28b70ea3c92350c9181aead0e83500a299c517d4 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 29 Sep 2023 12:43:24 +0200 Subject: [PATCH 16/45] Review feedback --- .../internal/LargeMessageProcessor.java | 1 - .../parameters/appconfig/AppConfigParam.java | 20 +++++++++ .../appconfig/AppConfigProviderTest.java | 34 ++++++++------- .../secrets/SecretsProviderTest.java | 13 +++--- .../parameters/ssm/SSMProviderTest.java | 43 +++++++++---------- 5 files changed, 64 insertions(+), 47 deletions(-) diff --git a/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java b/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java index 29508bc2f..5478931f1 100644 --- a/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java +++ b/powertools-large-messages/src/main/java/software/amazon/lambda/powertools/largemessages/internal/LargeMessageProcessor.java @@ -65,7 +65,6 @@ public Object process(ProceedingJoinPoint pjp, boolean deleteS3Object) throws Th String s3ObjectContent = getS3ObjectContent(payloadPointer); - if (LOG.isDebugEnabled()) { LOG.debug("Large message [{}] retrieved in S3 [{}]: {}KB", getMessageId(message), payloadPointer, s3ObjectContent.getBytes(StandardCharsets.UTF_8).length / 1024); diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java index d4b024b6a..07cacf8ba 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java @@ -20,14 +20,34 @@ import java.lang.annotation.Target; import software.amazon.lambda.powertools.parameters.transform.Transformer; +/** + * Use this annotation to inject AWS AppConfig parameters into fields in your application. You + * can also use {@code AppConfigProviderBuilder} to obtain AppConfig values directly, rather than + * injecting them implicitly. + * Both {@code environment} and {@code application} fields are necessary. + * + * @see AppConfigProviderBuilder + * @see Powertools for AWS Lambda (Java) parameters documentation + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface AppConfigParam { String key(); + /** + * Mandatory. Provide an environment to the {@link AppConfigProvider} + * + */ String environment(); + /** + * Mandatory. Provide an application to the {@link AppConfigProvider} + */ String application(); + /** + * Optional Provide a Transformer to transform the returned parameter values. + */ Class transformer() default Transformer.class; } diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java index 992fc64eb..a7a46e05e 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java @@ -14,6 +14,8 @@ package software.amazon.lambda.powertools.parameters.appconfig; +import static org.assertj.core.api.Assertions.assertThat; + import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -98,18 +100,18 @@ public void getValueRetrievesValue() { String returnedValue3 = provider.getValue(defaultTestKey); // Assert - Assertions.assertThat(returnedValue1).isEqualTo(firstResponse.configuration().asUtf8String()); - Assertions.assertThat(returnedValue2).isEqualTo(secondResponse.configuration().asUtf8String()); - Assertions.assertThat(returnedValue3).isEqualTo(secondResponse.configuration() + assertThat(returnedValue1).isEqualTo(firstResponse.configuration().asUtf8String()); + assertThat(returnedValue2).isEqualTo(secondResponse.configuration().asUtf8String()); + assertThat(returnedValue3).isEqualTo(secondResponse.configuration() .asUtf8String()); // Third response is mocked to return null and should re-use previous value - Assertions.assertThat(startSessionRequestCaptor.getValue().applicationIdentifier()).isEqualTo(applicationName); - Assertions.assertThat(startSessionRequestCaptor.getValue().environmentIdentifier()).isEqualTo(environmentName); - Assertions.assertThat(startSessionRequestCaptor.getValue().configurationProfileIdentifier()).isEqualTo(defaultTestKey); - Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( + assertThat(startSessionRequestCaptor.getValue().applicationIdentifier()).isEqualTo(applicationName); + assertThat(startSessionRequestCaptor.getValue().environmentIdentifier()).isEqualTo(environmentName); + assertThat(startSessionRequestCaptor.getValue().configurationProfileIdentifier()).isEqualTo(defaultTestKey); + assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( firstSession.initialConfigurationToken()); - Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( + assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( firstResponse.nextPollConfigurationToken()); - Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(2).configurationToken()).isEqualTo( + assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(2).configurationToken()).isEqualTo( secondResponse.nextPollConfigurationToken()); } @@ -133,7 +135,7 @@ public void getValueNoValueExists() { // Assert - Assertions.assertThat(returnedValue).isEqualTo(null); + assertThat(returnedValue).isEqualTo(null); } /** @@ -169,15 +171,15 @@ public void multipleKeysRetrievalWorks() { String secondKeyValue = provider.getValue(param2Key); // Assert - Assertions.assertThat(firstKeyValue).isEqualTo(param1Response.configuration().asUtf8String()); - Assertions.assertThat(secondKeyValue).isEqualTo(param2Response.configuration().asUtf8String()); - Assertions.assertThat(startSessionRequestCaptor.getAllValues().get(0).configurationProfileIdentifier()).isEqualTo( + assertThat(firstKeyValue).isEqualTo(param1Response.configuration().asUtf8String()); + assertThat(secondKeyValue).isEqualTo(param2Response.configuration().asUtf8String()); + assertThat(startSessionRequestCaptor.getAllValues().get(0).configurationProfileIdentifier()).isEqualTo( param1Key); - Assertions.assertThat(startSessionRequestCaptor.getAllValues().get(1).configurationProfileIdentifier()).isEqualTo( + assertThat(startSessionRequestCaptor.getAllValues().get(1).configurationProfileIdentifier()).isEqualTo( param2Key); - Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( + assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(0).configurationToken()).isEqualTo( param1Session.initialConfigurationToken()); - Assertions.assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( + assertThat(getLatestConfigurationRequestCaptor.getAllValues().get(1).configurationToken()).isEqualTo( param2Session.initialConfigurationToken()); } diff --git a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java index 2e0de7cf3..891639ff7 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java +++ b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java @@ -15,14 +15,11 @@ package software.amazon.lambda.powertools.parameters.secrets; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatIllegalStateException; import static org.assertj.core.api.Assertions.assertThatRuntimeException; import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.mockito.MockitoAnnotations.openMocks; import java.time.temporal.ChronoUnit; import java.util.Base64; -import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; @@ -70,8 +67,8 @@ public void getValue() { String value = provider.getValue(key); - Assertions.assertThat(value).isEqualTo(expectedValue); - Assertions.assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); + assertThat(value).isEqualTo(expectedValue); + assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); } @Test @@ -85,15 +82,15 @@ public void getValueBase64() { String value = provider.getValue(key); - Assertions.assertThat(value).isEqualTo(expectedValue); - Assertions.assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); + assertThat(value).isEqualTo(expectedValue); + assertThat(paramCaptor.getValue().secretId()).isEqualTo(key); } @Test public void getMultipleValuesThrowsException() { // Act & Assert - Assertions.assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) + assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) .withMessage("Impossible to get multiple values from AWS Secrets Manager"); } diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index 4814ebe1f..23ad2cd63 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -21,7 +21,6 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; -import org.assertj.core.api.Assertions; import org.assertj.core.data.MapEntry; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -73,9 +72,9 @@ public void getValue() { String value = provider.getValue(key); - Assertions.assertThat(value).isEqualTo(expectedValue); - Assertions.assertThat(paramCaptor.getValue().name()).isEqualTo(key); - Assertions.assertThat(paramCaptor.getValue().withDecryption()).isFalse(); + assertThat(value).isEqualTo(expectedValue); + assertThat(paramCaptor.getValue().name()).isEqualTo(key); + assertThat(paramCaptor.getValue().withDecryption()).isFalse(); } @Test @@ -86,9 +85,9 @@ public void getValueDecrypted() { String value = provider.withDecryption().getValue(key); - Assertions.assertThat(value).isEqualTo(expectedValue); - Assertions.assertThat(paramCaptor.getValue().name()).isEqualTo(key); - Assertions.assertThat(paramCaptor.getValue().withDecryption()).isTrue(); + assertThat(value).isEqualTo(expectedValue); + assertThat(paramCaptor.getValue().name()).isEqualTo(key); + assertThat(paramCaptor.getValue().withDecryption()).isTrue(); } @Test @@ -101,7 +100,7 @@ public void getMultiple() { Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); Map params = provider.getMultiple("/prod/app1"); - Assertions.assertThat(params).contains( + assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -109,9 +108,9 @@ public void getMultiple() { assertThat(provider.get("/prod/app1/key2")).isEqualTo("foo2"); assertThat(provider.get("/prod/app1/key3")).isEqualTo("foo3"); - Assertions.assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); - Assertions.assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); - Assertions.assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); + assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); + assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); + assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); } @Test @@ -124,7 +123,7 @@ public void getMultipleWithTrailingSlash() { Mockito.when(client.getParametersByPath(paramByPathCaptor.capture())).thenReturn(response); Map params = provider.getMultiple("/prod/app1/"); - Assertions.assertThat(params).contains( + assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -132,9 +131,9 @@ public void getMultipleWithTrailingSlash() { assertThat(provider.get("/prod/app1/key2")).isEqualTo("foo2"); assertThat(provider.get("/prod/app1/key3")).isEqualTo("foo3"); - Assertions.assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); - Assertions.assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); - Assertions.assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); + assertThat(paramByPathCaptor.getValue().path()).isEqualTo("/prod/app1"); + assertThat(paramByPathCaptor.getValue().withDecryption()).isFalse(); + assertThat(paramByPathCaptor.getValue().recursive()).isFalse(); } @Test @@ -174,7 +173,7 @@ public void getMultipleWithNextToken() { Map params = provider.getMultiple("/prod/app1"); - Assertions.assertThat(params).contains( + assertThat(params).contains( MapEntry.entry("key1", "foo1"), MapEntry.entry("key2", "foo2"), MapEntry.entry("key3", "foo3")); @@ -183,15 +182,15 @@ public void getMultipleWithNextToken() { GetParametersByPathRequest request1 = requestParams.get(0); GetParametersByPathRequest request2 = requestParams.get(1); - Assertions.assertThat(asList(request1, request2)).allSatisfy(req -> + assertThat(asList(request1, request2)).allSatisfy(req -> { - Assertions.assertThat(req.path()).isEqualTo("/prod/app1"); - Assertions.assertThat(req.withDecryption()).isFalse(); - Assertions.assertThat(req.recursive()).isFalse(); + assertThat(req.path()).isEqualTo("/prod/app1"); + assertThat(req.withDecryption()).isFalse(); + assertThat(req.recursive()).isFalse(); }); - Assertions.assertThat(request1.nextToken()).isNull(); - Assertions.assertThat(request2.nextToken()).isEqualTo("123abc"); + assertThat(request1.nextToken()).isNull(); + assertThat(request2.nextToken()).isEqualTo("123abc"); } private void initMock(String expectedValue) { From ee092905902885af94db672f5588b9471e708bf9 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Thu, 16 Nov 2023 09:02:42 +0100 Subject: [PATCH 17/45] Remove mockito config --- .../powertools-parameters-appconfig/pom.xml | 10 ---------- .../powertools-parameters-dynamodb/pom.xml | 10 ---------- .../powertools-parameters-secrets/pom.xml | 10 ---------- .../powertools-parameters-ssm/pom.xml | 10 ---------- .../powertools-parameters-tests/pom.xml | 10 ---------- 5 files changed, 50 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/pom.xml b/powertools-parameters/powertools-parameters-appconfig/pom.xml index 46c0dcd01..d44308f6b 100644 --- a/powertools-parameters/powertools-parameters-appconfig/pom.xml +++ b/powertools-parameters/powertools-parameters-appconfig/pom.xml @@ -70,16 +70,6 @@ junit-jupiter-engine test - - org.mockito - mockito-core - test - - - org.mockito - mockito-inline - test - org.apache.commons commons-lang3 diff --git a/powertools-parameters/powertools-parameters-dynamodb/pom.xml b/powertools-parameters/powertools-parameters-dynamodb/pom.xml index 71126f6b5..64fbea0fd 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/pom.xml +++ b/powertools-parameters/powertools-parameters-dynamodb/pom.xml @@ -70,16 +70,6 @@ junit-jupiter-engine test - - org.mockito - mockito-core - test - - - org.mockito - mockito-inline - test - org.apache.commons commons-lang3 diff --git a/powertools-parameters/powertools-parameters-secrets/pom.xml b/powertools-parameters/powertools-parameters-secrets/pom.xml index 5b4dfad34..0896d9646 100644 --- a/powertools-parameters/powertools-parameters-secrets/pom.xml +++ b/powertools-parameters/powertools-parameters-secrets/pom.xml @@ -70,16 +70,6 @@ junit-jupiter-engine test - - org.mockito - mockito-core - test - - - org.mockito - mockito-inline - test - org.apache.commons commons-lang3 diff --git a/powertools-parameters/powertools-parameters-ssm/pom.xml b/powertools-parameters/powertools-parameters-ssm/pom.xml index 47acd5906..dce95ae02 100644 --- a/powertools-parameters/powertools-parameters-ssm/pom.xml +++ b/powertools-parameters/powertools-parameters-ssm/pom.xml @@ -70,16 +70,6 @@ junit-jupiter-engine test - - org.mockito - mockito-core - test - - - org.mockito - mockito-inline - test - org.apache.commons commons-lang3 diff --git a/powertools-parameters/powertools-parameters-tests/pom.xml b/powertools-parameters/powertools-parameters-tests/pom.xml index b0bbfdf74..a6a177393 100644 --- a/powertools-parameters/powertools-parameters-tests/pom.xml +++ b/powertools-parameters/powertools-parameters-tests/pom.xml @@ -45,16 +45,6 @@ junit-jupiter-engine test - - org.mockito - mockito-core - test - - - org.mockito - mockito-inline - test - org.apache.commons commons-lang3 From f7cf9085b32299d407ec3229cc350bb3a2a91432 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Thu, 16 Nov 2023 12:57:56 +0100 Subject: [PATCH 18/45] Aspect tests for all the params aspects --- .../appconfig/AppConfigParamAspectTest.java | 14 +++++ .../dynamodb/DynamoDbParamAspect.java | 9 ++- .../dynamodb/DynamoDbParamAspectTest.java | 55 +++++++++++++++++++ .../secrets/SecretsParamAspect.java | 6 +- .../secrets/SecretsParamAspectTest.java | 49 +++++++++++++++++ .../parameters/ssm/SSMParamAspect.java | 7 ++- .../parameters/ssm/SSMParamAspectTest.java | 51 +++++++++++++++++ 7 files changed, 184 insertions(+), 7 deletions(-) create mode 100644 powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspectTest.java create mode 100644 powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspectTest.java create mode 100644 powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java index f38e67f0e..f50e88ec5 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParamAspectTest.java @@ -1,3 +1,17 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.appconfig; import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index 0d5d0d7a7..8e6f97aad 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -14,6 +14,7 @@ package software.amazon.lambda.powertools.parameters.dynamodb; +import java.util.function.Function; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; @@ -23,6 +24,10 @@ @Aspect public class DynamoDbParamAspect { + private static Function providerBuilder = + (String table) -> DynamoDbProvider.builder() + .withTable(table) + .build(); @Pointcut("get(* *) && @annotation(ddbConfigParam)") public void getParam(DynamoDbParam ddbConfigParam) { @@ -32,9 +37,7 @@ public void getParam(DynamoDbParam ddbConfigParam) { public Object injectParam(final ProceedingJoinPoint joinPoint, final DynamoDbParam ddbConfigParam) { System.out.println("GET IT"); - DynamoDbProvider provider = DynamoDbProvider.builder() - .withTable(ddbConfigParam.table()) - .build(); + DynamoDbProvider provider = providerBuilder.apply(ddbConfigParam.table()); if (ddbConfigParam.transformer().isInterface()) { // No transformation diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspectTest.java b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspectTest.java new file mode 100644 index 000000000..07e93a7c1 --- /dev/null +++ b/powertools-parameters/powertools-parameters-dynamodb/src/test/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspectTest.java @@ -0,0 +1,55 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.dynamodb; + +import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.function.Function; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +public class DynamoDbParamAspectTest { + + @Test + public void parameterInjectedByProvider() throws Exception { + // Setup our aspect to return a mocked DynamoDbProvider + String tableName = "my-test-tablename"; + String key = "myKey"; + String value = "myValue"; + DynamoDbProvider provider = Mockito.mock(DynamoDbProvider.class); + + Function providerBuilder = (String table) -> { + if (table.equals(tableName)) { + return provider; + } + throw new RuntimeException("Whoops! Asked for an app/env that we weren't configured for"); + }; + writeStaticField(DynamoDbParamAspect.class, "providerBuilder", providerBuilder, true); + + // Setup our mocked DynamoDbProvider to return a value for our test data + Mockito.when(provider.get(key)).thenReturn(value); + + // Create an instance of a class and let the AppConfigParametersAspect inject it + MyInjectedClass obj = new MyInjectedClass(); + assertThat(obj.myParameter).isEqualTo(value); + } + + class MyInjectedClass { + @DynamoDbParam(table = "my-test-tablename", key = "myKey") + public String myParameter; + } + +} diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index b38b8b0cd..d8055811d 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -14,6 +14,7 @@ package software.amazon.lambda.powertools.parameters.secrets; +import java.util.function.Supplier; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; @@ -23,6 +24,8 @@ @Aspect public class SecretsParamAspect { + private static Supplier providerBuilder = () -> SecretsProvider.builder() + .build(); @Pointcut("get(* *) && @annotation(secretsParam)") public void getParam(SecretsParam secretsParam) { @@ -32,8 +35,7 @@ public void getParam(SecretsParam secretsParam) { public Object injectParam(final ProceedingJoinPoint joinPoint, final SecretsParam secretsParam) { System.out.println("GET IT"); - SecretsProvider provider = SecretsProvider.builder() - .build(); + SecretsProvider provider = providerBuilder.get(); if (secretsParam.transformer().isInterface()) { // No transformation diff --git a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspectTest.java b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspectTest.java new file mode 100644 index 000000000..7aa0f0872 --- /dev/null +++ b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspectTest.java @@ -0,0 +1,49 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.secrets; + +import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.function.Supplier; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +public class SecretsParamAspectTest { + + @Test + public void parameterInjectedByProvider() throws Exception { + // Setup our aspect to return a mocked SecretsProvider + String key = "myKey"; + String value = "mySecretValue"; + SecretsProvider provider = Mockito.mock(SecretsProvider.class); + + Supplier providerBuilder = () -> provider; + writeStaticField(SecretsParamAspect.class, "providerBuilder", providerBuilder, true); + + // Setup our mocked SecretsProvider to return a value for our test data + Mockito.when(provider.get(key)).thenReturn(value); + + // Create an instance of a class and let the SecretsParamAspect inject it + MyInjectedClass obj = new MyInjectedClass(); + assertThat(obj.mySecret).isEqualTo(value); + } + + class MyInjectedClass { + @SecretsParam(key = "myKey") + public String mySecret; + } + +} diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 320aff33a..5207cb0eb 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -14,6 +14,7 @@ package software.amazon.lambda.powertools.parameters.ssm; +import java.util.function.Supplier; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; @@ -23,6 +24,9 @@ @Aspect public class SSMParamAspect { + // This supplier produces a new SSMProvider each time it is called + private static Supplier providerBuilder = () -> SSMProvider.builder() + .build(); @Pointcut("get(* *) && @annotation(secretsParam)") public void getParam(SSMParam secretsParam) { @@ -32,8 +36,7 @@ public void getParam(SSMParam secretsParam) { public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam SSMParam) { System.out.println("GET IT"); - SSMProvider provider = SSMProvider.builder() - .build(); + SSMProvider provider = providerBuilder.get(); if (SSMParam.transformer().isInterface()) { // No transformation diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java new file mode 100644 index 000000000..3826f5af5 --- /dev/null +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java @@ -0,0 +1,51 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters.ssm; + +import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.function.Supplier; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; +public class SSMParamAspectTest { + + // This class tests the SSM Param aspect in the same fashion + // as the tests for the aspects for the other providers. + + @Test + public void parameterInjectedByProvider() throws Exception { + + String key = "myKey"; + String value = "mySecretValue"; + SSMProvider provider = Mockito.mock(SSMProvider.class); + + Supplier providerBuilder = () -> provider; + writeStaticField(SSMParamAspect.class, "providerBuilder", providerBuilder, true); + + // Setup our mocked SSMProvider to return a value for our test data + Mockito.when(provider.get(key)).thenReturn(value); + + // Create an instance of a class and let the SSMParamAspect inject it + MyInjectedClass obj = new MyInjectedClass(); + assertThat(obj.mySecret).isEqualTo(value); + } + + class MyInjectedClass { + @SSMParam(key = "myKey") + public String mySecret; + } + +} From bf433f137a4b21fd16580968ff0cdf6df3045b20 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 22 Nov 2023 15:34:44 +0100 Subject: [PATCH 19/45] Write some docs --- docs/utilities/parameters.md | 600 ++++++------------ .../dynamodb/DynamoDbProviderBuilder.java | 2 +- ...ava => ParamProvidersIntegrationTest.java} | 4 +- 3 files changed, 211 insertions(+), 395 deletions(-) rename powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/{ParamManagerIntegrationTest.java => ParamProvidersIntegrationTest.java} (97%) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 85d30d77e..771ffa047 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -4,29 +4,40 @@ description: Utility --- -The parameters utility provides a way to retrieve parameter values from +The parameters utilities provide a way to retrieve parameter values from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html), [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/), or [Amazon DynamoDB](https://aws.amazon.com/dynamodb/). -It also provides a base class to create your parameter provider implementation. - + **Key features** -* Retrieve one or multiple parameters from the underlying provider +* Retrieve one or multiple parameters from an underlying provider in a standard way * Cache parameter values for a given amount of time (defaults to 5 seconds) * Transform parameter values from JSON or base 64 encoded strings ## Install -Depending on your version of Java (either Java 1.8 or 11+), the configuration slightly changes. +In order to provide lightweight dependencies, each parameters module is available as its own +package: + +* **Secrets Manager** - `powertools-parameters-secrets` - [A service that centrally manages the lifecycle of secrets](https://aws.amazon.com/secrets-manager/). Start here if you need to manage secrets only. +* **SSM Parameter Store** - `powertools-parameters-ssm` - [A secure, hierarchical store for configuration data management](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html). Start here if you need to manage various types of configuration data. +* **Amazon DynamoDB** -`powertools-parameters-dynamodb` - [A fast, flexible, NoSQL database](https://aws.amazon.com/dynamodb/) +* **AWS AppConfig** - `powertools-parameters-appconfig` - [An application focussed configuration store](https://aws.amazon.com/systems-manager/features/appconfig) - start here if you are interested in advanced use cases, such as incremental deployment of configuration changes + +You can easily mix and match parameter providers within the same project for different needs. + +Depending on which Java version you are using, you configuration will differ. Note that you must also provide +the concrete parameters module you want to use below - see the TODOs! === "Maven Java 11+" - ```xml hl_lines="3-7 16 18 24-27" + ```xml hl_lines="4-7 16 18 26-28" ... software.amazon.lambda - powertools-parameters - {{ powertools.version }} + + powertools-parameters-secrets + {{ powertools.version }} ... @@ -46,7 +57,8 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl software.amazon.lambda - powertools-parameters + + powertools-parameters-secrets @@ -65,12 +77,13 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl === "Maven Java 1.8" - ```xml hl_lines="3-7 16 18 24-27" + ```xml hl_lines="4-7 16 18 26-28" ... software.amazon.lambda - powertools-parameters + + powertools-parameters-secrets {{ powertools.version }} ... @@ -91,6 +104,7 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl software.amazon.lambda + powertools-parameters @@ -110,7 +124,7 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl === "Gradle Java 11+" - ```groovy hl_lines="3 11" + ```groovy hl_lines="3 11 12" plugins { id 'java' id 'io.freefair.aspectj.post-compile-weaving' version '8.1.0' @@ -121,7 +135,8 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl } dependencies { - aspect 'software.amazon.lambda:powertools-parameters:{{ powertools.version }}' + // TODO! Provide the parameters module you want to use here + aspect 'software.amazon.lambda:powertools-parameters-secrets:{{ powertools.version }}' } sourceCompatibility = 11 // or higher @@ -130,7 +145,7 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl === "Gradle Java 1.8" - ```groovy hl_lines="3 11" + ```groovy hl_lines="3 11 12" plugins { id 'java' id 'io.freefair.aspectj.post-compile-weaving' version '6.6.3' @@ -141,7 +156,8 @@ Depending on your version of Java (either Java 1.8 or 11+), the configuration sl } dependencies { - aspect 'software.amazon.lambda:powertools-parameters:{{ powertools.version }}' + // TODO! Provide the parameters module you want to use here + aspect 'software.amazon.lambda:powertools-parameters-secrets:{{ powertools.version }}' } sourceCompatibility = 1.8 @@ -159,260 +175,240 @@ SSM Parameter Store | `SSMProvider.getMultiple(String)` Secrets Manager | `SecretsProvider.get(String)` `SecretsProvider.get(String, Class)` | `secretsmanager:GetSecretValue` DynamoDB | `DynamoDBProvider.get(String)` `DynamoDBProvider.getMultiple(string)` | `dynamodb:GetItem` `dynamoDB:Query` -## SSM Parameter Store +## Retrieving Parameters +You can retrieve parameters either using annotations or by using the `xParamProvider` class for each parameter +provider directly. The latter is useful if you need to configure the underlying SDK client, for example to use +a different region or credentials, the former is simpler to use. -You can retrieve a single parameter using SSMProvider.get() and pass the key of the parameter. -For multiple parameters, you can use SSMProvider.getMultiple() and pass the path to retrieve them all. +### Using Annotations -Alternatively, you can retrieve an instance of a provider and configure its underlying SDK client, -in order to get data from other regions or use specific credentials. +=== "Secrets Manager: @SecretsParam" -=== "SSMProvider" - - ```java hl_lines="6" - import software.amazon.lambda.powertools.parameters.SSMProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; - - public class AppWithSSM implements RequestHandler { - // Get an instance of the SSM Provider - SSMProvider ssmProvider = ParamManager.getSsmProvider(); - - // Retrieve a single parameter - String value = ssmProvider.get("/my/parameter"); + ```java hl_lines="9 10" + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.lambda.powertools.parameters.secrets.SecretsParam; - // Retrieve multiple parameters from a path prefix - // This returns a Map with the parameter name as key - Map values = ssmProvider.getMultiple("/my/path/prefix"); - - } + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from secrets manager + @SecretsParam(key = "/powertools-java/userpwd") + String secretParam; ``` -=== "SSMProvider with a custom client" +=== "Systems Manager: @SSMParam" - ```java hl_lines="5 7" - import software.amazon.lambda.powertools.parameters.SSMProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + ```java hl_lines="9 10" + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.lambda.powertools.parameters.ssm.SSMParam; - public class AppWithSSM implements RequestHandler { - SsmClient client = SsmClient.builder().region(Region.EU_CENTRAL_1).build(); - // Get an instance of the SSM Provider - SSMProvider ssmProvider = ParamManager.getSsmProvider(client); - - // Retrieve a single parameter - String value = ssmProvider.get("/my/parameter"); - - // Retrieve multiple parameters from a path prefix - // This returns a Map with the parameter name as key - Map values = ssmProvider.getMultiple("/my/path/prefix"); - - } + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from SSM Parameter Store + @SSMParam(key = "/powertools-java/param") + String ssmParam; ``` -### Additional arguments +=== "DynamoDB: @DyanmoDbParam" -The AWS Systems Manager Parameter Store provider supports two additional arguments for the `get()` and `getMultiple()` methods: + ```java hl_lines="9 10" + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDBParam; -| Option | Default | Description | -|---------------|---------|-------------| -| **withDecryption()** | `False` | Will automatically decrypt the parameter. | -| **recursive()** | `False` | For `getMultiple()` only, will fetch all parameter values recursively based on a path prefix. | + public class ParametersFunction implements RequestHandler { -**Example:** + // Annotation-style injection from DynamoDB + @DynamoDbParam(table = "my-test-tablename", key = "myKey") + String ddbParam; + ``` -=== "AppWithSSM.java" +=== "AppConfig: @AppConfigParam" - ```java hl_lines="9 12" - import software.amazon.lambda.powertools.parameters.SSMProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + ```java hl_lines="9 10" + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.lambda.powertools.parameters.appconfig.AppConfigParam; - public class AppWithSSM implements RequestHandler { - // Get an instance of the SSM Provider - SSMProvider ssmProvider = ParamManager.getSsmProvider(); - - // Retrieve a single parameter and decrypt it - String value = ssmProvider.withDecryption().get("/my/parameter"); + public class ParametersFunction implements RequestHandler { - // Retrieve multiple parameters recursively from a path prefix - Map values = ssmProvider.recursive().getMultiple("/my/path/prefix"); - - } + // Annotation-style injection from AppConfig + @AppConfigParam(application = "my-app", environment = "my-env", key = "myKey") + String appConfigParam; ``` -## Secrets Manager -For secrets stored in Secrets Manager, use `getSecretsProvider`. +### Using the `ParamProvider` classes -Alternatively, you can retrieve an instance of a provider and configure its underlying SDK client, -in order to get data from other regions or use specific credentials. +=== "Secrets Manager" - -=== "SecretsProvider" - - ```java hl_lines="9" - import software.amazon.lambda.powertools.parameters.SecretsProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + ```java hl_lines="15-19 23-28" + import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; + + import com.amazonaws.services.lambda.runtime.Context; + import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; + import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; + + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import java.time.temporal.ChronoUnit; public class AppWithSecrets implements RequestHandler { - // Get an instance of the Secrets Provider - SecretsProvider secretsProvider = ParamManager.getSecretsProvider(); - // Retrieve a single secret - String value = secretsProvider.get("/my/secret"); + // Get an instance of the SecretsProvider. We can provide a custom client here if we want, + // for instance to use a particular region. + SecretsProvider secretsProvider = SecretsProvider + .builder() + .withClient(SecretsManagerClient.builder().build()) + .build(); + public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + // Retrieve a single secret + String value = secretsProvider + // Transform parameter from base64 + .withTransformation(base64) + // By default values are cached for 5 seconds, specify 10 seconds instead. + .withMaxAge(10, ChronoUnit.SECONDS) + .get("/my/secret"); + + // Return the result + return new APIGatewayProxyResponseEvent() + .withStatusCode(200) + .withBody(value); + } } ``` -=== "SecretsProvider with a custom client" +=== "Systems Manager" - ```java hl_lines="5 7" - import software.amazon.lambda.powertools.parameters.SecretsProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + ```java hl_lines="15-19 23-28" + import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; + + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.awssdk.services.ssm.SsmClient; + import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; + import java.time.temporal.ChronoUnit; public class AppWithSecrets implements RequestHandler { - SecretsManagerClient client = SecretsManagerClient.builder().region(Region.EU_CENTRAL_1).build(); - // Get an instance of the Secrets Provider - SecretsProvider secretsProvider = ParamManager.getSecretsProvider(client); - // Retrieve a single secret - String value = secretsProvider.get("/my/secret"); + // Get an instance of the SSMProvider. We can provide a custom client here if we want, + // for instance to use a particular region. + SSMProvider ssmProvider = SSMProvider + .builder() + .withClient(SsmClient.builder().build()) + .build(); + public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + // Retrieve a single secret + String value = ssmProvider + // Transform parameter from base64 + .withTransformation(base64) + // By default values are cached for 5 seconds, specify 10 seconds instead. + .withMaxAge(10, ChronoUnit.SECONDS) + .get("/my/secret"); + + // Return the result + return new APIGatewayProxyResponseEvent() + .withStatusCode(200) + .withBody(value); + } } ``` -## DynamoDB -To get secrets stored in DynamoDB, use `getDynamoDbProvider`, providing the name of the table that -contains the secrets. As with the other providers, an overloaded methods allows you to retrieve -a `DynamoDbProvider` providing a client if you need to configure it yourself. - -=== "DynamoDbProvider" - - ```java hl_lines="6 9" - import software.amazon.lambda.powertools.parameters.DynamoDbProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; +=== "DynamoDB" - public class AppWithDynamoDbParameters implements RequestHandler { - // Get an instance of the DynamoDbProvider - DynamoDbProvider ddbProvider = ParamManager.getDynamoDbProvider("my-parameters-table"); + ```java hl_lines="15-19 23-28" + import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; - // Retrieve a single parameter - String value = ddbProvider.get("my-key"); - } - ``` - -=== "DynamoDbProvider with a custom client" - - ```java hl_lines="9 10 11 12 15 18" - import software.amazon.lambda.powertools.parameters.DynamoDbProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; - import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; - import software.amazon.awssdk.regions.Region; - - public class AppWithDynamoDbParameters implements RequestHandler { - // Get a DynamoDB Client with an explicit region - DynamoDbClient ddbClient = DynamoDbClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.EU_CENTRAL_2) - .build(); - - // Get an instance of the DynamoDbProvider - DynamoDbProvider provider = ParamManager.getDynamoDbProvider(ddbClient, "test-table"); - - // Retrieve a single parameter - String value = ddbProvider.get("my-key"); - } - ``` - -## AppConfig -To get parameters stored in AppConfig, use `getAppConfigProvider`, providing the application and environment -name to retrieve configuration from. As with the other providers, an overloaded method allows you to retrieve -an `AppConfigProvider` providing a client if you need to configure it yourself. - -=== "AppConfigProvider" - - ```java hl_lines="6 9" - import software.amazon.lambda.powertools.parameters.AppConfigProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProvider; + import java.time.temporal.ChronoUnit; - public class AppWitAppConfigParameters implements RequestHandler { - // Get an instance of the AppConfigProvider - AppConfigProvider appConfigProvider = ParamManager.getAppConfigProvider("my-environment", "my-app"); + public class AppWithSecrets implements RequestHandler { - // Retrieve a single parameter - String value = appConfigProvider.get("my-key"); - } - ``` - -=== "AppConfigProvider with a custom client" - - ```java hl_lines="9 10 11 12 15 18" - import software.amazon.lambda.powertools.parameters.AppConfigProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; - import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; - import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient; - import software.amazon.awssdk.regions.Region; - - public class AppWithDynamoDbParameters implements RequestHandler { - // Get an AppConfig Client with an explicit region - AppConfigDataClient appConfigDataClient = AppConfigDataClient.builder() - .httpClientBuilder(UrlConnectionHttpClient.builder()) - .region(Region.EU_CENTRAL_2) + // Get an instance of the SecretsProvider. We can provide a custom client here if we want, + // for instance to use a particular region. + DynamoDbProvider ddbProvider = DynamoDbProvider + .builder() + .withClient(DynamoDbClient.builder().build()) .build(); - - // Get an instance of the DynamoDbProvider - AppConfigProvider appConfigProvider = ParamManager.getAppConfigProvider(appConfigDataClient, "my-environment", "my-app"); - // Retrieve a single parameter - String value = appConfigProvider.get("my-key"); - } + public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + // Retrieve a single secret + String value = ddbProvider + // Transform parameter from base64 + .withTransformation(base64) + // By default values are cached for 5 seconds, specify 10 seconds instead. + .withMaxAge(10, ChronoUnit.SECONDS) + .get("/my/secret"); + + // Return the result + return new APIGatewayProxyResponseEvent() + .withStatusCode(200) + .withBody(value); + } + } ``` +=== "AppConfig" -## Advanced configuration - -### Caching - -By default, all parameters and their corresponding values are cached for 5 seconds. - -You can customize this default value using `defaultMaxAge`. You can also customize this value for each parameter using -`withMaxAge`. - -=== "Provider with default Max age" - - ```java hl_lines="9" - import software.amazon.lambda.powertools.parameters.SecretsProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; + ```java hl_lines="15-19 23-28" + import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; + + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; + import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; + import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; + import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; + import java.time.temporal.ChronoUnit; public class AppWithSecrets implements RequestHandler { - // Get an instance of the Secrets Provider - SecretsProvider secretsProvider = ParamManager.getSecretsProvider() - .defaultMaxAge(10, ChronoUnit.SECONDS); - - String value = secretsProvider.get("/my/secret"); - } + // Get an instance of the SecretsProvider. We can provide a custom client here if we want, + // for instance to use a particular region. + AppConfigProvider appConfigProvider = AppConfigProvider + .builder() + .withClient(AppConfigDataClient.builder().build()) + .build(); + + public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + // Retrieve a single secret + String value = appConfigProvider + // Transform parameter from base64 + .withTransformation(base64) + // By default values are cached for 5 seconds, specify 10 seconds instead. + .withMaxAge(10, ChronoUnit.SECONDS) + .get("/my/secret"); + + // Return the result + return new APIGatewayProxyResponseEvent() + .withStatusCode(200) + .withBody(value); + } + } ``` -=== "Provider with age for each param" - - ```java hl_lines="8" - import software.amazon.lambda.powertools.parameters.SecretsProvider; - import software.amazon.lambda.powertools.parameters.ParamManager; +## Advanced configuration - public class AppWithSecrets implements RequestHandler { - SecretsManagerClient client = SecretsManagerClient.builder().region(Region.EU_CENTRAL_1).build(); - - SecretsProvider secretsProvider = ParamManager.getSecretsProvider(client); - - String value = secretsProvider.withMaxAge(10, ChronoUnit.SECONDS).get("/my/secret"); - - } - ``` ### Transform values Parameter values can be transformed using ```withTransformation(transformerClass)```. -Base64 and JSON transformations are provided. For more complex transformation, you need to specify how to deserialize- +Base64 and JSON transformations are provided. For more complex transformation, you need to specify how to deserialize. !!! warning "`SSMProvider.getMultiple()` does not support transformation and will return simple Strings." @@ -431,7 +427,7 @@ Base64 and JSON transformations are provided. For more complex transformation, y .get("/my/parameter/json", MyObj.class); ``` -## Write your own Transformer +### Write your own Transformer You can write your own transformer, by implementing the `Transformer` interface and the `applyTransformation()` method. For example, if you wish to deserialize XML into an object. @@ -461,181 +457,3 @@ For example, if you wish to deserialize XML into an object. .withTransformation(XmlTransformer.class) .get("/my/parameter/xml", MyObj.class); ``` - -### Fluent API - -To simplify the use of the library, you can chain all method calls before a get. - -=== "Fluent API call" - - ```java - ssmProvider - .defaultMaxAge(10, SECONDS) // will set 10 seconds as the default cache TTL - .withMaxAge(1, MINUTES) // will set the cache TTL for this value at 1 minute - .withTransformation(json) // json is a static import from Transformer.json - .withDecryption() // enable decryption of the parameter value - .get("/my/param", MyObj.class); // finally get the value - ``` - -## Create your own provider - -You can create your own custom parameter store provider by inheriting the ```BaseProvider``` class and implementing the -```String getValue(String key)``` method to retrieve data from your underlying store. All transformation and caching logic is handled by the get() methods in the base class. - -=== "Example implementation using S3 as a custom parameter" - - ```java - public class S3Provider extends BaseProvider { - - private final S3Client client; - private String bucket; - - S3Provider(CacheManager cacheManager) { - this(cacheManager, S3Client.create()); - } - - S3Provider(CacheManager cacheManager, S3Client client) { - super(cacheManager); - this.client = client; - } - - public S3Provider withBucket(String bucket) { - this.bucket = bucket; - return this; - } - - @Override - protected String getValue(String key) { - if (bucket == null) { - throw new IllegalStateException("A bucket must be specified, using withBucket() method"); - } - - GetObjectRequest request = GetObjectRequest.builder().bucket(bucket).key(key).build(); - ResponseBytes response = client.getObject(request, ResponseTransformer.toBytes()); - return response.asUtf8String(); - } - - @Override - protected Map getMultipleValues(String path) { - if (bucket == null) { - throw new IllegalStateException("A bucket must be specified, using withBucket() method"); - } - - ListObjectsV2Request listRequest = ListObjectsV2Request.builder().bucket(bucket).prefix(path).build(); - List s3Objects = client.listObjectsV2(listRequest).contents(); - - Map result = new HashMap<>(); - s3Objects.forEach(s3Object -> { - result.put(s3Object.key(), getValue(s3Object.key())); - }); - - return result; - } - - @Override - protected void resetToDefaults() { - super.resetToDefaults(); - bucket = null; - } - - } - ``` - -=== "Using custom parameter store" - - ```java hl_lines="3" - S3Provider provider = new S3Provider(ParamManager.getCacheManager()); - - provider.setTransformationManager(ParamManager.getTransformationManager()); - - String value = provider.withBucket("myBucket").get("myKey"); - ``` - -## Annotation - -You can make use of the annotation `@Param` to inject a parameter value in a variable. - -By default, it will use `SSMProvider` to retrieve the value from AWS System Manager Parameter Store. -You could specify a different provider as long as it extends `BaseProvider` and/or a `Transformer`. - -=== "Param Annotation" - - ```java hl_lines="3" - public class AppWithAnnotation implements RequestHandler { - - @Param(key = "/my/parameter/json") - ObjectToDeserialize value; - - } - ``` - -=== "Custom Provider Usage" - - ```java hl_lines="3" - public class AppWithAnnotation implements RequestHandler { - - @Param(key = "/my/parameter/json" provider = SecretsProvider.class, transformer = JsonTransformer.class) - ObjectToDeserialize value; - - } - ``` - - In this case ```SecretsProvider``` will be used to retrieve a raw value that is then trasformed into the target Object by using ```JsonTransformer```. - To show the convenience of the annotation compare the following two code snippets. - - -### Install - -If you want to use the ```@Param``` annotation in your project add configuration to compile-time weave (CTW) the powertools-parameters aspects into your project. - -=== "Maven" - - ```xml - - - ... - - dev.aspectj - aspectj-maven-plugin - 1.13.1 - - ... - - ... - - software.amazon.lambda - powertools-parameters - - - - - - - compile - - - - - ... - - - ``` - -=== "Gradle" - - ```groovy - plugins{ - id 'java' - id 'io.freefair.aspectj.post-compile-weaving' version '6.3.0' - } - - repositories { - mavenCentral() - } - - dependencies { - ... - aspect 'software.amazon.lambda:powertools-parameters:{{ powertools.version }}' - implementation 'org.aspectj:aspectjrt:1.9.19' - } - ``` \ No newline at end of file diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index dd81b6469..66e33c70d 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -25,7 +25,7 @@ import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; -class DynamoDbProviderBuilder { +public class DynamoDbProviderBuilder { private DynamoDbClient client; private String table; private CacheManager cacheManager; diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java similarity index 97% rename from powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java rename to powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java index dce1bf664..fe7b66959 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamManagerIntegrationTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java @@ -14,7 +14,6 @@ package software.amazon.lambda.powertools.parameters; -import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.times; @@ -25,7 +24,6 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; import org.assertj.core.data.MapEntry; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -45,7 +43,7 @@ import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; -public class ParamManagerIntegrationTest { +public class ParamProvidersIntegrationTest { @Mock SsmClient ssmClient; From 2a7f9cb4d7dcc1edbd479aa7b8f688f072c083fd Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 22 Nov 2023 15:40:19 +0100 Subject: [PATCH 20/45] rearrange pom --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 4c022db75..3c2768b98 100644 --- a/pom.xml +++ b/pom.xml @@ -57,8 +57,8 @@ powertools-parameters/powertools-parameters-ssm powertools-parameters/powertools-parameters-secrets powertools-parameters/powertools-parameters-dynamodb - powertools-parameters/powertools-parameters-tests powertools-parameters/powertools-parameters-appconfig + powertools-parameters/powertools-parameters-tests From 54c16647369d72f3b02e8e90098715f25ebe24a5 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 22 Nov 2023 15:44:38 +0100 Subject: [PATCH 21/45] More warning ignores --- powertools-parameters/spotbugs-exclude.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/powertools-parameters/spotbugs-exclude.xml b/powertools-parameters/spotbugs-exclude.xml index a7f4e4d8c..5903492f3 100644 --- a/powertools-parameters/spotbugs-exclude.xml +++ b/powertools-parameters/spotbugs-exclude.xml @@ -63,6 +63,20 @@ + + + + + + + + + + + + + + From 762baf381aaad7628fe612c437bec629c86f0701 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Thu, 23 Nov 2023 08:50:01 +0100 Subject: [PATCH 22/45] Removed some unecessary overrides --- .../dynamodb/DynamoDbProviderBuilder.java | 5 ++++ .../parameters/secrets/SecretsProvider.java | 28 ------------------ .../parameters/ssm/SSMProvider.java | 29 ------------------- .../powertools/parameters/BaseProvider.java | 2 +- 4 files changed, 6 insertions(+), 58 deletions(-) diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index 66e33c70d..6fd525b83 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -14,6 +14,7 @@ package software.amazon.lambda.powertools.parameters.dynamodb; +import java.time.temporal.ChronoUnit; import software.amazon.awssdk.core.SdkSystemSetting; import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; @@ -31,6 +32,10 @@ public class DynamoDbProviderBuilder { private CacheManager cacheManager; private TransformationManager transformationManager; + // Allows the user to override default max age + private int maxAge; + private ChronoUnit unit; + static DynamoDbClient createClient() { return DynamoDbClient.builder() .httpClientBuilder(UrlConnectionHttpClient.builder()) diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index 3e54a82e8..600db6212 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -16,7 +16,6 @@ import static java.nio.charset.StandardCharsets.UTF_8; -import java.time.temporal.ChronoUnit; import java.util.Base64; import java.util.Map; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; @@ -24,7 +23,6 @@ import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; -import software.amazon.lambda.powertools.parameters.transform.Transformer; /** * AWS Secrets Manager Parameter Provider

@@ -100,32 +98,6 @@ protected Map getMultipleValues(String path) { throw new UnsupportedOperationException("Impossible to get multiple values from AWS Secrets Manager"); } - /** - * {@inheritDoc} - */ - @Override - public SecretsProvider defaultMaxAge(int maxAge, ChronoUnit unit) { - super.defaultMaxAge(maxAge, unit); - return this; - } - - /** - * {@inheritDoc} - */ - @Override - public SecretsProvider withMaxAge(int maxAge, ChronoUnit unit) { - super.withMaxAge(maxAge, unit); - return this; - } - - /** - * {@inheritDoc} - */ - @Override - public SecretsProvider withTransformation(Class transformerClass) { - super.withTransformation(transformerClass); - return this; - } // For test purpose only SecretsManagerClient getClient() { diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java index 43cf18653..55e1a67c1 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java @@ -14,7 +14,6 @@ package software.amazon.lambda.powertools.parameters.ssm; -import java.time.temporal.ChronoUnit; import java.util.HashMap; import java.util.Map; import software.amazon.awssdk.services.ssm.SsmClient; @@ -25,7 +24,6 @@ import software.amazon.lambda.powertools.parameters.BaseProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; -import software.amazon.lambda.powertools.parameters.transform.Transformer; /** * AWS System Manager Parameter Store Provider

@@ -109,33 +107,6 @@ public String getValue(String key) { return client.getParameter(request).parameter().value(); } - /** - * {@inheritDoc} - */ - @Override - public SSMProvider defaultMaxAge(int maxAge, ChronoUnit unit) { - super.defaultMaxAge(maxAge, unit); - return this; - } - - /** - * {@inheritDoc} - */ - @Override - public SSMProvider withMaxAge(int maxAge, ChronoUnit unit) { - super.withMaxAge(maxAge, unit); - return this; - } - - /** - * {@inheritDoc} - */ - @Override - public SSMProvider withTransformation(Class transformerClass) { - super.withTransformation(transformerClass); - return this; - } - /** * Tells System Manager Parameter Store to decrypt the parameter value.
* By default, parameter values are not decrypted.
diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java index 0afed3413..1b6f5786a 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java @@ -69,7 +69,7 @@ public BaseProvider(CacheManager cacheManager, TransformationManager transformat * @param unit Unit of time * @return the provider itself in order to chain calls (eg. 

provider.defaultMaxAge(10, SECONDS).get("key")
). */ - protected BaseProvider defaultMaxAge(int maxAge, ChronoUnit unit) { + public BaseProvider defaultMaxAge(int maxAge, ChronoUnit unit) { Duration duration = Duration.of(maxAge, unit); cacheManager.setDefaultExpirationTime(duration); return this; From b5e0602b73814efb50840a0c7ec5a1653f27df03 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 28 Nov 2023 08:04:35 +0100 Subject: [PATCH 23/45] Remove defaultMaxAge from BaseProvider intf --- .../demo/parameters/ParametersFunction.java | 2 +- .../secrets/SecretsProviderTest.java | 1 - .../parameters/ssm/SSMProviderTest.java | 1 - .../parameters/BaseProviderTest.java | 30 +++++++++---------- .../powertools/parameters/BaseProvider.java | 17 +---------- 5 files changed, 17 insertions(+), 34 deletions(-) diff --git a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java index 57f953d43..9a1d3636b 100644 --- a/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java +++ b/examples/powertools-examples-parameters/src/main/java/org/demo/parameters/ParametersFunction.java @@ -54,7 +54,7 @@ public class ParametersFunction implements RequestHandler allValues = ssmProvider.getMultiple("/powertools-java/sample"); diff --git a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java index 891639ff7..21173cad1 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java +++ b/powertools-parameters/powertools-parameters-secrets/src/test/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderTest.java @@ -62,7 +62,6 @@ public void getValue() { String expectedValue = "Value1"; GetSecretValueResponse response = GetSecretValueResponse.builder().secretString(expectedValue).build(); Mockito.when(client.getSecretValue(paramCaptor.capture())).thenReturn(response); - provider.defaultMaxAge(1, ChronoUnit.DAYS); provider.withMaxAge(2, ChronoUnit.DAYS); String value = provider.getValue(key); diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index 23ad2cd63..25a06595c 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -197,7 +197,6 @@ private void initMock(String expectedValue) { Parameter parameter = Parameter.builder().value(expectedValue).build(); GetParameterResponse result = GetParameterResponse.builder().parameter(parameter).build(); Mockito.when(client.getParameter(paramCaptor.capture())).thenReturn(result); - provider.defaultMaxAge(1, ChronoUnit.DAYS); provider.withMaxAge(2, ChronoUnit.DAYS); provider.recursive(); } diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java index a4cdd85af..c4a0ef391 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java @@ -25,6 +25,7 @@ import static software.amazon.lambda.powertools.parameters.transform.Transformer.json; import java.time.Clock; +import java.time.Duration; import java.time.temporal.ChronoUnit; import java.util.Base64; import java.util.HashMap; @@ -136,8 +137,10 @@ public void get_customTTL_expired_shouldGetValue() { } @Test + // TODO Scott - remove this, or change to mutating the CacheManager first? public void get_customDefaultTTL_cached_shouldGetFromCache() { - provider.defaultMaxAge(12, ChronoUnit.MINUTES).get("foobar"); + provider.cacheManager.setDefaultExpirationTime(Duration.of(12, MINUTES)); + provider.get("foobar"); getFromStore = false; provider.setClock(offset(clock, of(10, MINUTES))); @@ -148,7 +151,6 @@ public void get_customDefaultTTL_cached_shouldGetFromCache() { @Test public void get_customDefaultTTL_expired_shouldGetValue() { - provider.defaultMaxAge(2, ChronoUnit.MINUTES).get("barbaz"); getFromStore = false; provider.setClock(offset(clock, of(3, MINUTES))); @@ -159,9 +161,7 @@ public void get_customDefaultTTL_expired_shouldGetValue() { @Test public void get_customDefaultTTLAndTTL_cached_shouldGetFromCache() { - provider.defaultMaxAge(12, ChronoUnit.MINUTES) - .withMaxAge(5, SECONDS) - .get("foobaz"); + provider.get("foobaz"); getFromStore = false; provider.setClock(offset(clock, of(4, SECONDS))); @@ -172,8 +172,7 @@ public void get_customDefaultTTLAndTTL_cached_shouldGetFromCache() { @Test public void get_customDefaultTTLAndTTL_expired_shouldGetValue() { - provider.defaultMaxAge(2, ChronoUnit.MINUTES) - .withMaxAge(5, SECONDS) + provider.withMaxAge(5, SECONDS) .get("bariton"); getFromStore = false; @@ -274,8 +273,9 @@ public void getObject_customTTL_expired_shouldGetValue() { public void getObject_customDefaultTTL_cached_shouldGetFromCache() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.defaultMaxAge(12, ChronoUnit.MINUTES) - .withTransformation(json) + provider.cacheManager.setDefaultExpirationTime(Duration.of(12, MINUTES)); + + provider.withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; @@ -286,11 +286,11 @@ public void getObject_customDefaultTTL_cached_shouldGetFromCache() { } @Test + // TODO Scott public void getObject_customDefaultTTL_expired_shouldGetValue() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.defaultMaxAge(2, ChronoUnit.MINUTES) - .withTransformation(json) + provider.withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; @@ -301,10 +301,10 @@ public void getObject_customDefaultTTL_expired_shouldGetValue() { } @Test + // TODO Scott public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.defaultMaxAge(12, ChronoUnit.MINUTES) - .withMaxAge(5, SECONDS) + provider.withMaxAge(5, SECONDS) .withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; @@ -316,11 +316,11 @@ public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() { } @Test + // TODO Scott public void getObject_customDefaultTTLAndTTL_expired_shouldGetValue() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.defaultMaxAge(2, ChronoUnit.MINUTES) - .withMaxAge(5, SECONDS) + provider.withMaxAge(5, SECONDS) .withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java index 1b6f5786a..bedace28c 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseProvider.java @@ -60,25 +60,10 @@ public BaseProvider(CacheManager cacheManager, TransformationManager transformat */ protected abstract Map getMultipleValues(String path); - /** - * (Optional) Set the default max age for the cache of all parameters. Override the default 5 seconds.
- * If for some parameters, you need to set a different maxAge, use {@link #withMaxAge(int, ChronoUnit)}.
- * Use {@link #withMaxAge(int, ChronoUnit)} after {#defaultMaxAge(int, ChronoUnit)} in the chain. - * - * @param maxAge Maximum time to cache the parameter, before calling the underlying parameter store. - * @param unit Unit of time - * @return the provider itself in order to chain calls (eg. 
provider.defaultMaxAge(10, SECONDS).get("key")
). - */ - public BaseProvider defaultMaxAge(int maxAge, ChronoUnit unit) { - Duration duration = Duration.of(maxAge, unit); - cacheManager.setDefaultExpirationTime(duration); - return this; - } - /** * (Optional) Builder method to call before {@link #get(String)} or {@link #get(String, Class)} * to set cache max age for the parameter to get.

- * The max age is reset to default (either 5 or a custom value set with {@link #defaultMaxAge}) after each get, + * The max age is reset to default (either 5 or a custom value that may be set on the CacheManager) after each get, * so you need to use this method for each parameter to cache with non-default max age.

* * Not Thread Safe: calling this method simultaneously by several threads From 8e680f7b8f96752e57044b4acb360e6429e338e4 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 11:28:43 +0100 Subject: [PATCH 24/45] Refactoring param aspects to pull out shared code --- .../appconfig/AppConfigParametersAspect.java | 23 ++-------- .../dynamodb/DynamoDbParamAspect.java | 25 +++-------- .../secrets/SecretsParamAspect.java | 22 ++-------- .../parameters/ssm/SSMParamAspect.java | 23 ++-------- .../parameters/BaseParamAspect.java | 42 +++++++++++++++++++ .../lambda/powertools/parameters}/pom.xml | 0 6 files changed, 58 insertions(+), 77 deletions(-) create mode 100644 powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java rename powertools-parameters/{ => src/main/java/software/amazon/lambda/powertools/parameters}/pom.xml (100%) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index dec439302..ac726a031 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -20,9 +20,10 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.BaseParamAspect; @Aspect -public class AppConfigParametersAspect { +public class AppConfigParametersAspect extends BaseParamAspect { private static BiFunction providerBuilder = (String env, String app) -> AppConfigProvider.builder() @@ -37,28 +38,12 @@ public void getParam(AppConfigParam appConfigParamAnnotation) { @Around("getParam(appConfigParamAnnotation)") public Object injectParam(final ProceedingJoinPoint joinPoint, final AppConfigParam appConfigParamAnnotation) { - System.out.println("GET IT"); AppConfigProvider provider = providerBuilder.apply (appConfigParamAnnotation.environment(), appConfigParamAnnotation.application()); - if (appConfigParamAnnotation.transformer().isInterface()) { - // No transformation - return provider.get(appConfigParamAnnotation.key()); - } else { - FieldSignature s = (FieldSignature) joinPoint.getSignature(); - if (String.class.isAssignableFrom(s.getFieldType())) { - // Basic transformation - return provider - .withTransformation(appConfigParamAnnotation.transformer()) - .get(appConfigParamAnnotation.key()); - } else { - // Complex transformation - return provider - .withTransformation(appConfigParamAnnotation.transformer()) - .get(appConfigParamAnnotation.key(), s.getFieldType()); - } - } + return getAndTransform(appConfigParamAnnotation.key(), appConfigParamAnnotation.transformer(), provider, + (FieldSignature) joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index 8e6f97aad..2ac121ed5 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -20,9 +20,11 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.BaseParamAspect; +import software.amazon.lambda.powertools.parameters.BaseProvider; @Aspect -public class DynamoDbParamAspect { +public class DynamoDbParamAspect extends BaseParamAspect { private static Function providerBuilder = (String table) -> DynamoDbProvider.builder() @@ -37,25 +39,8 @@ public void getParam(DynamoDbParam ddbConfigParam) { public Object injectParam(final ProceedingJoinPoint joinPoint, final DynamoDbParam ddbConfigParam) { System.out.println("GET IT"); - DynamoDbProvider provider = providerBuilder.apply(ddbConfigParam.table()); - - if (ddbConfigParam.transformer().isInterface()) { - // No transformation - return provider.get(ddbConfigParam.key()); - } else { - FieldSignature s = (FieldSignature) joinPoint.getSignature(); - if (String.class.isAssignableFrom(s.getFieldType())) { - // Basic transformation - return provider - .withTransformation(ddbConfigParam.transformer()) - .get(ddbConfigParam.key()); - } else { - // Complex transformation - return provider - .withTransformation(ddbConfigParam.transformer()) - .get(ddbConfigParam.key(), s.getFieldType()); - } - } + BaseProvider provider = providerBuilder.apply(ddbConfigParam.table()); + return getAndTransform(ddbConfigParam.key(), ddbConfigParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index d8055811d..e947a7107 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -20,9 +20,10 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.BaseParamAspect; @Aspect -public class SecretsParamAspect { +public class SecretsParamAspect extends BaseParamAspect { private static Supplier providerBuilder = () -> SecretsProvider.builder() .build(); @@ -36,24 +37,7 @@ public Object injectParam(final ProceedingJoinPoint joinPoint, final SecretsPara System.out.println("GET IT"); SecretsProvider provider = providerBuilder.get(); - - if (secretsParam.transformer().isInterface()) { - // No transformation - return provider.get(secretsParam.key()); - } else { - FieldSignature s = (FieldSignature) joinPoint.getSignature(); - if (String.class.isAssignableFrom(s.getFieldType())) { - // Basic transformation - return provider - .withTransformation(secretsParam.transformer()) - .get(secretsParam.key()); - } else { - // Complex transformation - return provider - .withTransformation(secretsParam.transformer()) - .get(secretsParam.key(), s.getFieldType()); - } - } + return getAndTransform(secretsParam.key(), secretsParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 5207cb0eb..8d684fd78 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -20,9 +20,11 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.BaseParamAspect; +import software.amazon.lambda.powertools.parameters.BaseProvider; @Aspect -public class SSMParamAspect { +public class SSMParamAspect extends BaseParamAspect { // This supplier produces a new SSMProvider each time it is called private static Supplier providerBuilder = () -> SSMProvider.builder() @@ -37,24 +39,7 @@ public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam SS System.out.println("GET IT"); SSMProvider provider = providerBuilder.get(); - - if (SSMParam.transformer().isInterface()) { - // No transformation - return provider.get(SSMParam.key()); - } else { - FieldSignature s = (FieldSignature) joinPoint.getSignature(); - if (String.class.isAssignableFrom(s.getFieldType())) { - // Basic transformation - return provider - .withTransformation(SSMParam.transformer()) - .get(SSMParam.key()); - } else { - // Complex transformation - return provider - .withTransformation(SSMParam.transformer()) - .get(SSMParam.key(), s.getFieldType()); - } - } + return getAndTransform(SSMParam.key(), SSMParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); } } diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java new file mode 100644 index 000000000..acde71cf9 --- /dev/null +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java @@ -0,0 +1,42 @@ +/* + * Copyright 2023 Amazon.com, Inc. or its affiliates. + * Licensed under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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.lambda.powertools.parameters; + +import org.aspectj.lang.reflect.FieldSignature; +import software.amazon.lambda.powertools.parameters.transform.Transformer; + +public class BaseParamAspect { + + protected Object getAndTransform(String key, Class transformer, BaseProvider provider, + FieldSignature fieldSignature) { + if (transformer.isInterface()) { + // No transformation + return provider.get(key); + } else { + Class fieldType = fieldSignature.getFieldType(); + if (String.class.isAssignableFrom(fieldType)) { + // Basic transformation + return provider + .withTransformation(transformer) + .get(key); + } else { + // Complex transformation + return provider + .withTransformation(transformer) + .get(key, fieldType); + } + } + } +} diff --git a/powertools-parameters/pom.xml b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/pom.xml similarity index 100% rename from powertools-parameters/pom.xml rename to powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/pom.xml From cb87a5c2b185d9d2030c0d1ad13cbc82b66e5f8e Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 11:29:19 +0100 Subject: [PATCH 25/45] Refactoring param aspects to pull out shared code --- .../appconfig/AppConfigParametersAspect.java | 5 +++++ .../dynamodb/DynamoDbParamAspect.java | 5 +++++ .../dynamodb/DynamoDbProviderBuilder.java | 3 --- .../parameters/secrets/SecretsParamAspect.java | 5 +++++ .../parameters/ssm/SSMParamAspect.java | 5 +++++ .../powertools/parameters/BaseParamAspect.java | 18 +++++++++++++++++- 6 files changed, 37 insertions(+), 4 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index ac726a031..0c7610434 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -22,6 +22,11 @@ import org.aspectj.lang.reflect.FieldSignature; import software.amazon.lambda.powertools.parameters.BaseParamAspect; +/** + * Provides the AppConfig parameter aspect. This aspect is responsible for injecting + * parameters from AppConfig into fields annotated with @AppConfigParam. See the + * README and Powertools for Lambda (Java) documentation for information on using this feature. + */ @Aspect public class AppConfigParametersAspect extends BaseParamAspect { diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index 2ac121ed5..f04b65678 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -23,6 +23,11 @@ import software.amazon.lambda.powertools.parameters.BaseParamAspect; import software.amazon.lambda.powertools.parameters.BaseProvider; +/** + * Provides the DynamoDB parameter aspect. This aspect is responsible for injecting + * parameters from DynamoDB into fields annotated with @DynamoDbParam. See the + * README and Powertools for Lambda (Java) documentation for information on using this feature. + */ @Aspect public class DynamoDbParamAspect extends BaseParamAspect { diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index 6fd525b83..1eab340d6 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -31,9 +31,6 @@ public class DynamoDbProviderBuilder { private String table; private CacheManager cacheManager; private TransformationManager transformationManager; - - // Allows the user to override default max age - private int maxAge; private ChronoUnit unit; static DynamoDbClient createClient() { diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index e947a7107..d68ed22d7 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -22,6 +22,11 @@ import org.aspectj.lang.reflect.FieldSignature; import software.amazon.lambda.powertools.parameters.BaseParamAspect; +/** + * Provides the Secrets parameter aspect. This aspect is responsible for injecting + * parameters from Secrets Provider into fields annotated with @SecretsParam. See the + * README and Powertools for Lambda (Java) documentation for information on using this feature. + */ @Aspect public class SecretsParamAspect extends BaseParamAspect { diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 8d684fd78..140af0330 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -23,6 +23,11 @@ import software.amazon.lambda.powertools.parameters.BaseParamAspect; import software.amazon.lambda.powertools.parameters.BaseProvider; +/** + * Provides the SSM parameter store parameter aspect. This aspect is responsible for injecting + * parameters from SSM Parameter Store into fields annotated with @SSMParam. See the + * README and Powertools for Lambda (Java) documentation for information on using this feature. + */ @Aspect public class SSMParamAspect extends BaseParamAspect { diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java index acde71cf9..53ed48733 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java @@ -17,8 +17,24 @@ import org.aspectj.lang.reflect.FieldSignature; import software.amazon.lambda.powertools.parameters.transform.Transformer; -public class BaseParamAspect { +/** + * Provides a common base for all parameter aspects. This lets us group functionality that + * we need to reimplement in each aspect. This class should be extended for each + * additional parameter aspect. + */ +public abstract class BaseParamAspect { + /** + * Gets the parameter value from the provider and transforms it if necessary. This transformation + * is generic across all parameter providers. + * + * @param key The key of the parameter to get + * @param transformer The transformer to use to transform the parameter value + * @param provider A concrete instance of the parameter provider to retrieve the value from + * @param fieldSignature The signature of the field that the parameter is being injected into + * + * @return The value of the parameter, transformed if necessary + */ protected Object getAndTransform(String key, Class transformer, BaseProvider provider, FieldSignature fieldSignature) { if (transformer.isInterface()) { From e283e4ab37f37766e92936b4f5fc4fdbe3a54f26 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 11:32:14 +0100 Subject: [PATCH 26/45] Undid madness --- .../software/amazon/lambda/powertools/parameters => }/pom.xml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename powertools-parameters/{src/main/java/software/amazon/lambda/powertools/parameters => }/pom.xml (100%) diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/pom.xml b/powertools-parameters/pom.xml similarity index 100% rename from powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/pom.xml rename to powertools-parameters/pom.xml From 9f8486fc0f754d7e010ef0e4419e36874409ec0d Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 11:39:15 +0100 Subject: [PATCH 27/45] Another unused field --- .../powertools/parameters/dynamodb/DynamoDbProviderBuilder.java | 1 - 1 file changed, 1 deletion(-) diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index 1eab340d6..a0dd80186 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -31,7 +31,6 @@ public class DynamoDbProviderBuilder { private String table; private CacheManager cacheManager; private TransformationManager transformationManager; - private ChronoUnit unit; static DynamoDbClient createClient() { return DynamoDbClient.builder() From a955fac637103bcd8698e2e32e06c1f6b456c681 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 12:00:55 +0100 Subject: [PATCH 28/45] Checkstyle --- .../parameters/appconfig/AppConfigParam.java | 1 - .../appconfig/AppConfigParametersAspect.java | 10 +++++----- .../parameters/appconfig/AppConfigProvider.java | 3 ++- .../parameters/dynamodb/DynamoDbParamAspect.java | 5 +++-- .../parameters/dynamodb/DynamoDbProvider.java | 9 +++++---- .../parameters/dynamodb/DynamoDbProviderBuilder.java | 1 - .../parameters/secrets/SecretsParamAspect.java | 5 +++-- .../powertools/parameters/secrets/SecretsProvider.java | 3 ++- .../powertools/parameters/ssm/SSMParamAspect.java | 10 +++++----- .../lambda/powertools/parameters/ssm/SSMProvider.java | 2 +- .../powertools/parameters/ssm/SSMParamAspectTest.java | 1 + .../powertools/parameters/ssm/SSMProviderTest.java | 3 ++- .../lambda/powertools/parameters/BaseParamAspect.java | 7 +++---- 13 files changed, 32 insertions(+), 28 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java index 07cacf8ba..32ba97a2e 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java @@ -37,7 +37,6 @@ /** * Mandatory. Provide an environment to the {@link AppConfigProvider} - * */ String environment(); diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index 0c7610434..5e65dab7b 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -30,11 +30,11 @@ @Aspect public class AppConfigParametersAspect extends BaseParamAspect { - private static BiFunction providerBuilder = - (String env, String app) -> AppConfigProvider.builder() - .withEnvironment(env) - .withApplication(app) - .build(); + private static final BiFunction providerBuilder = + (String env, String app) -> AppConfigProvider.builder() + .withEnvironment(env) + .withApplication(app) + .build(); @Pointcut("get(* *) && @annotation(appConfigParamAnnotation)") diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java index 596a2b917..d884e4512 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java @@ -46,7 +46,8 @@ public class AppConfigProvider extends BaseProvider { private final String environment; private final HashMap establishedSessions = new HashMap<>(); - AppConfigProvider(CacheManager cacheManager, TransformationManager transformationManager, AppConfigDataClient client, String environment, String application) { + AppConfigProvider(CacheManager cacheManager, TransformationManager transformationManager, + AppConfigDataClient client, String environment, String application) { super(cacheManager, transformationManager); this.client = client; this.application = application; diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index f04b65678..6f7c8bc0e 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -31,7 +31,7 @@ @Aspect public class DynamoDbParamAspect extends BaseParamAspect { - private static Function providerBuilder = + private static final Function providerBuilder = (String table) -> DynamoDbProvider.builder() .withTable(table) .build(); @@ -45,7 +45,8 @@ public Object injectParam(final ProceedingJoinPoint joinPoint, final DynamoDbPar System.out.println("GET IT"); BaseProvider provider = providerBuilder.apply(ddbConfigParam.table()); - return getAndTransform(ddbConfigParam.key(), ddbConfigParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); + return getAndTransform(ddbConfigParam.key(), ddbConfigParam.transformer(), provider, + (FieldSignature) joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index 5df1c7e58..adf316fc3 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -40,7 +40,8 @@ public class DynamoDbProvider extends BaseProvider { private final DynamoDbClient client; private final String tableName; - DynamoDbProvider(CacheManager cacheManager, TransformationManager transformationManager, DynamoDbClient client, String tableName) { + DynamoDbProvider(CacheManager cacheManager, TransformationManager transformationManager, DynamoDbClient client, + String tableName) { super(cacheManager, transformationManager); this.client = client; this.tableName = tableName; @@ -74,7 +75,7 @@ protected String getValue(String key) { // If we don't have an item at the key, we should return null. if (resp.hasItem() && !resp.item().values().isEmpty()) { if (!resp.item().containsKey("value")) { - throw new DynamoDbProviderSchemaException("Missing 'value': " + resp.item().toString()); + throw new DynamoDbProviderSchemaException("Missing 'value': " + resp.item()); } return resp.item().get("value").s(); } @@ -103,10 +104,10 @@ protected Map getMultipleValues(String path) { .peek((i) -> { if (!i.containsKey("sk")) { - throw new DynamoDbProviderSchemaException("Missing 'sk': " + i.toString()); + throw new DynamoDbProviderSchemaException("Missing 'sk': " + i); } if (!i.containsKey("value")) { - throw new DynamoDbProviderSchemaException("Missing 'value': " + i.toString()); + throw new DynamoDbProviderSchemaException("Missing 'value': " + i); } }) .collect( diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index a0dd80186..66e33c70d 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -14,7 +14,6 @@ package software.amazon.lambda.powertools.parameters.dynamodb; -import java.time.temporal.ChronoUnit; import software.amazon.awssdk.core.SdkSystemSetting; import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration; import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index d68ed22d7..2d216d94e 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -30,7 +30,7 @@ @Aspect public class SecretsParamAspect extends BaseParamAspect { - private static Supplier providerBuilder = () -> SecretsProvider.builder() + private static final Supplier providerBuilder = () -> SecretsProvider.builder() .build(); @Pointcut("get(* *) && @annotation(secretsParam)") @@ -42,7 +42,8 @@ public Object injectParam(final ProceedingJoinPoint joinPoint, final SecretsPara System.out.println("GET IT"); SecretsProvider provider = providerBuilder.get(); - return getAndTransform(secretsParam.key(), secretsParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); + return getAndTransform(secretsParam.key(), secretsParam.transformer(), provider, + (FieldSignature) joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index 600db6212..6fe6194f3 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -57,7 +57,8 @@ public class SecretsProvider extends BaseProvider { * * @param client custom client you would like to use. */ - SecretsProvider(CacheManager cacheManager, TransformationManager transformationManager, SecretsManagerClient client) { + SecretsProvider(CacheManager cacheManager, TransformationManager transformationManager, + SecretsManagerClient client) { super(cacheManager, transformationManager); this.client = client; } diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 140af0330..2ff73904e 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -21,7 +21,6 @@ import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.FieldSignature; import software.amazon.lambda.powertools.parameters.BaseParamAspect; -import software.amazon.lambda.powertools.parameters.BaseProvider; /** * Provides the SSM parameter store parameter aspect. This aspect is responsible for injecting @@ -32,19 +31,20 @@ public class SSMParamAspect extends BaseParamAspect { // This supplier produces a new SSMProvider each time it is called - private static Supplier providerBuilder = () -> SSMProvider.builder() + private static final Supplier providerBuilder = () -> SSMProvider.builder() .build(); @Pointcut("get(* *) && @annotation(secretsParam)") public void getParam(SSMParam secretsParam) { } - @Around("getParam(SSMParam)") - public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam SSMParam) { + @Around("getParam(ssmPaam)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam ssmPaam) { System.out.println("GET IT"); SSMProvider provider = providerBuilder.get(); - return getAndTransform(SSMParam.key(), SSMParam.transformer(), provider, (FieldSignature)joinPoint.getSignature()); + return getAndTransform(ssmPaam.key(), ssmPaam.transformer(), provider, + (FieldSignature) joinPoint.getSignature()); } } diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java index 55e1a67c1..3a88c90be 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java @@ -75,7 +75,7 @@ public class SSMProvider extends BaseProvider { *

* Use the {@link SSMProviderBuilder} to create an instance of it. * - * @param client custom client you would like to use. + * @param client custom client you would like to use. * @param transformationManager Null, or a transformation manager */ SSMProvider(CacheManager cacheManager, TransformationManager transformationManager, SsmClient client) { diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java index 3826f5af5..e56d20ffa 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspectTest.java @@ -20,6 +20,7 @@ import java.util.function.Supplier; import org.junit.jupiter.api.Test; import org.mockito.Mockito; + public class SSMParamAspectTest { // This class tests the SSM Param aspect in the same fashion diff --git a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java index 25a06595c..b105da438 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java +++ b/powertools-parameters/powertools-parameters-ssm/src/test/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderTest.java @@ -153,7 +153,8 @@ public void getMultiple_cached_shouldNotCallSSM() { provider.get("/prod/app1/key2"); provider.get("/prod/app1/key3"); - Mockito.verify(client, Mockito.times(1)).getParametersByPath(ArgumentMatchers.any(GetParametersByPathRequest.class)); + Mockito.verify(client, Mockito.times(1)) + .getParametersByPath(ArgumentMatchers.any(GetParametersByPathRequest.class)); } diff --git a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java index 53ed48733..f7ebdf97a 100644 --- a/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java +++ b/powertools-parameters/src/main/java/software/amazon/lambda/powertools/parameters/BaseParamAspect.java @@ -28,11 +28,10 @@ public abstract class BaseParamAspect { * Gets the parameter value from the provider and transforms it if necessary. This transformation * is generic across all parameter providers. * - * @param key The key of the parameter to get - * @param transformer The transformer to use to transform the parameter value - * @param provider A concrete instance of the parameter provider to retrieve the value from + * @param key The key of the parameter to get + * @param transformer The transformer to use to transform the parameter value + * @param provider A concrete instance of the parameter provider to retrieve the value from * @param fieldSignature The signature of the field that the parameter is being injected into - * * @return The value of the parameter, transformed if necessary */ protected Object getAndTransform(String key, Class transformer, BaseProvider provider, From 9c86b6fa66aba4924e1a3ce09483a6a41b60d965 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Wed, 29 Nov 2023 12:15:10 +0100 Subject: [PATCH 29/45] Drop final modifier for tests --- .../parameters/appconfig/AppConfigParametersAspect.java | 2 +- .../powertools/parameters/dynamodb/DynamoDbParamAspect.java | 2 +- .../powertools/parameters/secrets/SecretsParamAspect.java | 2 +- .../amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java index 5e65dab7b..b151da6e0 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java @@ -30,7 +30,7 @@ @Aspect public class AppConfigParametersAspect extends BaseParamAspect { - private static final BiFunction providerBuilder = + private static BiFunction providerBuilder = (String env, String app) -> AppConfigProvider.builder() .withEnvironment(env) .withApplication(app) diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index 6f7c8bc0e..d3b49e021 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -31,7 +31,7 @@ @Aspect public class DynamoDbParamAspect extends BaseParamAspect { - private static final Function providerBuilder = + private static Function providerBuilder = (String table) -> DynamoDbProvider.builder() .withTable(table) .build(); diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index 2d216d94e..8e897762d 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -30,7 +30,7 @@ @Aspect public class SecretsParamAspect extends BaseParamAspect { - private static final Supplier providerBuilder = () -> SecretsProvider.builder() + private static Supplier providerBuilder = () -> SecretsProvider.builder() .build(); @Pointcut("get(* *) && @annotation(secretsParam)") diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 2ff73904e..3d238149e 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -31,7 +31,7 @@ public class SSMParamAspect extends BaseParamAspect { // This supplier produces a new SSMProvider each time it is called - private static final Supplier providerBuilder = () -> SSMProvider.builder() + private static Supplier providerBuilder = () -> SSMProvider.builder() .build(); @Pointcut("get(* *) && @annotation(secretsParam)") From cf170d49dd6c9ee35577fc2f7a5f21941e4c397d Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 09:44:05 +0100 Subject: [PATCH 30/45] Review comments --- docs/utilities/parameters.md | 340 +++++++++++++----- mkdocs.yml | 2 +- .../parameters/ssm/SSMProviderBuilder.java | 5 +- .../powertools-parameters-tests/pom.xml | 5 +- .../parameters/BaseProviderTest.java | 21 +- 5 files changed, 277 insertions(+), 96 deletions(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 771ffa047..064d6e747 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -6,9 +6,10 @@ description: Utility The parameters utilities provide a way to retrieve parameter values from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html), -[AWS Secrets Manager](https://aws.amazon.com/secrets-manager/), or [Amazon DynamoDB](https://aws.amazon.com/dynamodb/). +[AWS Secrets Manager](https://aws.amazon.com/secrets-manager/), [Amazon DynamoDB](https://aws.amazon.com/dynamodb/), +or [AWS AppConfig](https://aws.amazon.com/systems-manager/features/appconfig/). -**Key features** +## Key features * Retrieve one or multiple parameters from an underlying provider in a standard way * Cache parameter values for a given amount of time (defaults to 5 seconds) @@ -18,10 +19,10 @@ The parameters utilities provide a way to retrieve parameter values from In order to provide lightweight dependencies, each parameters module is available as its own package: -* **Secrets Manager** - `powertools-parameters-secrets` - [A service that centrally manages the lifecycle of secrets](https://aws.amazon.com/secrets-manager/). Start here if you need to manage secrets only. -* **SSM Parameter Store** - `powertools-parameters-ssm` - [A secure, hierarchical store for configuration data management](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html). Start here if you need to manage various types of configuration data. -* **Amazon DynamoDB** -`powertools-parameters-dynamodb` - [A fast, flexible, NoSQL database](https://aws.amazon.com/dynamodb/) -* **AWS AppConfig** - `powertools-parameters-appconfig` - [An application focussed configuration store](https://aws.amazon.com/systems-manager/features/appconfig) - start here if you are interested in advanced use cases, such as incremental deployment of configuration changes +* **Secrets Manager** - `powertools-parameters-secrets` +* **SSM Parameter Store** - `powertools-parameters-ssm` +* **Amazon DynamoDB** -`powertools-parameters-dynamodb` +* **AWS AppConfig** - `powertools-parameters-appconfig` You can easily mix and match parameter providers within the same project for different needs. @@ -30,13 +31,18 @@ the concrete parameters module you want to use below - see the TODOs! === "Maven Java 11+" - ```xml hl_lines="4-7 16 18 26-28" + ```xml hl_lines="4-12 17 24 30-34" ... software.amazon.lambda + powertools-parameters-secrets + powertools-parameters-ssm + powertools-parameters-dynamodb + powertools-parameters-appconfig + {{ powertools.version }} ... @@ -55,9 +61,9 @@ the concrete parameters module you want to use below - see the TODOs! 11 11 + software.amazon.lambda - powertools-parameters-secrets @@ -77,14 +83,19 @@ the concrete parameters module you want to use below - see the TODOs! === "Maven Java 1.8" - ```xml hl_lines="4-7 16 18 26-28" + ```xml hl_lines="4-12 17 24 30-34" ... software.amazon.lambda + powertools-parameters-secrets - {{ powertools.version }} + powertools-parameters-ssm + powertools-parameters-dynamodb + powertools-parameters-appconfig + + {{ powertools.version }} ... @@ -102,10 +113,10 @@ the concrete parameters module you want to use below - see the TODOs! 1.8 1.8 + software.amazon.lambda - - powertools-parameters + powertools-parameters-secrets @@ -155,8 +166,8 @@ the concrete parameters module you want to use below - see the TODOs! mavenCentral() } + // TODO! Provide an aspectLibrary for each of the parameters module(s) you want to use here dependencies { - // TODO! Provide the parameters module you want to use here aspect 'software.amazon.lambda:powertools-parameters-secrets:{{ powertools.version }}' } @@ -168,12 +179,14 @@ the concrete parameters module you want to use below - see the TODOs! This utility requires additional permissions to work as expected. See the table below: -Provider | Function/Method | IAM Permission -------------------------------------------------- |----------------------------------------------------------------------| --------------------------------------------------------------------------------- -SSM Parameter Store | `SSMProvider.get(String)` `SSMProvider.get(String, Class)` | `ssm:GetParameter` -SSM Parameter Store | `SSMProvider.getMultiple(String)` | `ssm:GetParametersByPath` -Secrets Manager | `SecretsProvider.get(String)` `SecretsProvider.get(String, Class)` | `secretsmanager:GetSecretValue` -DynamoDB | `DynamoDBProvider.get(String)` `DynamoDBProvider.getMultiple(string)` | `dynamodb:GetItem` `dynamoDB:Query` +| Provider | Function/Method | IAM Permission | +|-----------|-------------------------------------------------------------------------|---------------------------------------------------------------------------| +| SSM | `SSMProvider.get(String)` `SSMProvider.get(String, Class)` | `ssm:GetParameter` | +| SSM | `SSMProvider.getMultiple(String)` | `ssm:GetParametersByPath` | +| SSM | If using `withDecryption(true)` | You must add an additional permission `kms:Decrypt` | +| Secrets | `SecretsProvider.get(String)` `SecretsProvider.get(String, Class)` | `secretsmanager:GetSecretValue` | +| DynamoDB | `DynamoDBProvider.get(String)` `DynamoDBProvider.getMultiple(string)` | `dynamodb:GetItem` `dynamoDB:Query` | +| AppConfig | `AppConfigProvider.get(String)` `AppConfigProvider.getMultiple(string)` | `appconfig:StartConfigurationSession`, `appConfig:GetLatestConfiguration` | ## Retrieving Parameters You can retrieve parameters either using annotations or by using the `xParamProvider` class for each parameter @@ -184,62 +197,80 @@ a different region or credentials, the former is simpler to use. === "Secrets Manager: @SecretsParam" - ```java hl_lines="9 10" + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.lambda.powertools.parameters.secrets.SecretsParam; - public class ParametersFunction implements RequestHandler { + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from secrets manager + @SecretsParam(key = "/powertools-java/userpwd") + String secretParam; - // Annotation-style injection from secrets manager - @SecretsParam(key = "/powertools-java/userpwd") - String secretParam; + public string handleRequest(String request, Context context) { + // Because this is a secret, we probably don't want to return it! Return something indicating + // we could access it instead. + return "Retrieved a secret, and sensibly refusing to return it!"; + } + } ``` -=== "Systems Manager: @SSMParam" +=== "SSM Parameters Store: @SSMParam" - ```java hl_lines="9 10" + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.lambda.powertools.parameters.ssm.SSMParam; - public class ParametersFunction implements RequestHandler { + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from SSM Parameter Store + @SSMParam(key = "/powertools-java/param") + String ssmParam; - // Annotation-style injection from SSM Parameter Store - @SSMParam(key = "/powertools-java/param") - String ssmParam; + public string handleRequest(String request, Context context) { + return ssmParam; // Request handler simply returns our configuration value + } + } ``` === "DynamoDB: @DyanmoDbParam" - ```java hl_lines="9 10" + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDBParam; - public class ParametersFunction implements RequestHandler { + public class ParametersFunction implements RequestHandler { - // Annotation-style injection from DynamoDB - @DynamoDbParam(table = "my-test-tablename", key = "myKey") - String ddbParam; + // Annotation-style injection from DynamoDB + @DynamoDbParam(table = "my-test-tablename", key = "myKey") + String ddbParam; + + public string handleRequest(String request, Context context) { + return ddbParam; // Request handler simply returns our configuration value + } + } ``` === "AppConfig: @AppConfigParam" - ```java hl_lines="9 10" + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.lambda.powertools.parameters.appconfig.AppConfigParam; - public class ParametersFunction implements RequestHandler { + public class ParametersFunction implements RequestHandler { - // Annotation-style injection from AppConfig - @AppConfigParam(application = "my-app", environment = "my-env", key = "myKey") - String appConfigParam; + // Annotation-style injection from AppConfig + @AppConfigParam(application = "my-app", environment = "my-env", key = "myKey") + String appConfigParam; + + public string handleRequest(String request, Context context) { + return appConfigParam; // Request handler simply returns our configuration value + } + } ``` @@ -247,19 +278,16 @@ a different region or credentials, the former is simpler to use. === "Secrets Manager" - ```java hl_lines="15-19 23-28" + ```java hl_lines="13-16 20-25" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; - import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import java.time.temporal.ChronoUnit; - public class AppWithSecrets implements RequestHandler { + public class RequestHandlerWithParams implements RequestHandler { // Get an instance of the SecretsProvider. We can provide a custom client here if we want, // for instance to use a particular region. @@ -268,7 +296,7 @@ a different region or credentials, the former is simpler to use. .withClient(SecretsManagerClient.builder().build()) .build(); - public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + public String handleRequest(String input, Context context) { // Retrieve a single secret String value = secretsProvider // Transform parameter from base64 @@ -277,28 +305,25 @@ a different region or credentials, the former is simpler to use. .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); - // Return the result - return new APIGatewayProxyResponseEvent() - .withStatusCode(200) - .withBody(value); + // Because this is a secret, we probably don't want to return it! Return something indicating + // we could access it instead. + return "Retrieved a secret, and sensibly refusing to return it!"; } } ``` === "Systems Manager" - ```java hl_lines="15-19 23-28" + ```java hl_lines="13-16 20-27" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; import java.time.temporal.ChronoUnit; - public class AppWithSecrets implements RequestHandler { + public class RequestHandlerWithParams implements RequestHandler { // Get an instance of the SSMProvider. We can provide a custom client here if we want, // for instance to use a particular region. @@ -307,7 +332,7 @@ a different region or credentials, the former is simpler to use. .withClient(SsmClient.builder().build()) .build(); - public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + public String handleRequest(String input, Context context) { // Retrieve a single secret String value = ssmProvider // Transform parameter from base64 @@ -315,29 +340,27 @@ a different region or credentials, the former is simpler to use. // By default values are cached for 5 seconds, specify 10 seconds instead. .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); - + // We might instead want to retrieve multiple secrets at once, returning a Map of key/value pairs + // .getMultiple("/my/secret/path"); + // Return the result - return new APIGatewayProxyResponseEvent() - .withStatusCode(200) - .withBody(value); + return value; } } ``` === "DynamoDB" - ```java hl_lines="15-19 23-28" + ```java hl_lines="13-16 20-27" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProvider; import java.time.temporal.ChronoUnit; - public class AppWithSecrets implements RequestHandler { + public class RequestHandlerWithParams implements RequestHandler { // Get an instance of the SecretsProvider. We can provide a custom client here if we want, // for instance to use a particular region. @@ -346,7 +369,7 @@ a different region or credentials, the former is simpler to use. .withClient(DynamoDbClient.builder().build()) .build(); - public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + public String handleRequest(String input, Context context) { // Retrieve a single secret String value = ddbProvider // Transform parameter from base64 @@ -354,29 +377,27 @@ a different region or credentials, the former is simpler to use. // By default values are cached for 5 seconds, specify 10 seconds instead. .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); + // We might instead want to retrieve multiple values at once, returning a Map of key/value pairs + // .getMultiple("my-partition-key-value"); // Return the result - return new APIGatewayProxyResponseEvent() - .withStatusCode(200) - .withBody(value); + return value; } } ``` === "AppConfig" - ```java hl_lines="15-19 23-28" + ```java hl_lines="13-16 20-25" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent; - import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent; import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; import java.time.temporal.ChronoUnit; - public class AppWithSecrets implements RequestHandler { + public class RequestHandlerWithParams implements RequestHandler { // Get an instance of the SecretsProvider. We can provide a custom client here if we want, // for instance to use a particular region. @@ -385,7 +406,7 @@ a different region or credentials, the former is simpler to use. .withClient(AppConfigDataClient.builder().build()) .build(); - public APIGatewayProxyResponseEvent handleRequest(APIGatewayProxyRequestEvent input, Context context) { + public String handleRequest(String input, Context context) { // Retrieve a single secret String value = appConfigProvider // Transform parameter from base64 @@ -395,22 +416,52 @@ a different region or credentials, the former is simpler to use. .get("/my/secret"); // Return the result - return new APIGatewayProxyResponseEvent() - .withStatusCode(200) - .withBody(value); + return value; } } ``` ## Advanced configuration +### Default cache timeout +Each provider uses the CacheManager to cache parameter values. By default, values are cached for 5 seconds. If you +wish to customize this, you can provide a custom `CacheManager` to your provider with an appropriate timeout configured. +`CacheManager` instances can also be shared between providers. + +=== "Customize Cache" + + ```java hl_lines="9 10 14 19" + import java.time.Duration; + import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; + import software.amazon.lambda.powertools.parameters.cache.CacheManager; + + public class CustomizeCache { + + public void CustomizeCache() { + + CacheManager cacheManager = new CacheManager(); + cacheManager.setDefaultExpirationTime(Duration.ofSeconds(10)); + + AppConfigProvider paramProvider = AppConfigProvider + .builder() + .withCacheManager(cacheManager) + .withClient(AppConfigDataClient.builder().build()) + .build(); + + // We can override the default per `get` + paramProvider.withMaxAge(20, ChronoUnit.SECONDS) + .get("my-param"); + } + } + ``` + ### Transform values Parameter values can be transformed using ```withTransformation(transformerClass)```. Base64 and JSON transformations are provided. For more complex transformation, you need to specify how to deserialize. -!!! warning "`SSMProvider.getMultiple()` does not support transformation and will return simple Strings." +!!! warning "`getMultiple()` does not support transformation and will return simple Strings." === "Base64 Transformation" ```java @@ -427,7 +478,7 @@ Base64 and JSON transformations are provided. For more complex transformation, y .get("/my/parameter/json", MyObj.class); ``` -### Write your own Transformer +### Create your own Transformer You can write your own transformer, by implementing the `Transformer` interface and the `applyTransformation()` method. For example, if you wish to deserialize XML into an object. @@ -457,3 +508,122 @@ For example, if you wish to deserialize XML into an object. .withTransformation(XmlTransformer.class) .get("/my/parameter/xml", MyObj.class); ``` + +### Create your own Provider +You can create your own custom parameter store provider by implementing a handful of classes: + +=== "CustomProvider.java" + + ```java + import java.util.Map; + import software.amazon.lambda.powertools.parameters.BaseProvider; + import software.amazon.lambda.powertools.parameters.cache.CacheManager; + import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + + public class CustomProvider extends BaseProvider { + + public CustomProvider(CacheManager cacheManager, TransformationManager transformationManager) { + super(cacheManager, transformationManager); + } + + public CustomProviderBuilder builder() { + return new CustomProviderBuilder(); + } + + @Override + protected String getValue(String key) { + throw new RuntimeException("TODO - return a single value"); + } + + @Override + protected Map getMultipleValues(String path) { + throw new RuntimeException("TODO - Optional - return multiple values"); + } + } + ``` + +=== "CustomProviderBuilder.java" + + ```java + public class CustomProviderBuilder { + private CacheManager cacheManager; + private TransformationManager transformationManager; + + /** + * Create a {@link DynamoDbProvider} instance. + * + * @return a {@link DynamoDbProvider} + */ + public CustomProvider build() { + if (cacheManager == null) { + cacheManager = new CacheManager(); + } + return new CustomProvider(cacheManager, transformationManager); + } + + /** + * Provide a CacheManager to the {@link CustomProvider} + * + * @param cacheManager the manager that will handle the cache of parameters + * @return the builder to chain calls (eg. 

builder.withCacheManager().build()
) + */ + public CustomProviderBuilder withCacheManager(CacheManager cacheManager) { + this.cacheManager = cacheManager; + return this; + } + + /** + * Provide a transformationManager to the {@link DynamoDbProvider} + * + * @param transformationManager the manager that will handle transformation of parameters + * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) + */ + public CustomProviderBuilder withTransformationManager(TransformationManager transformationManager) { + this.transformationManager = transformationManager; + return this; + } + } + ``` + +=== "CustomProviderParam.java" + + ```java + import java.lang.annotation.ElementType; + import java.lang.annotation.Retention; + import java.lang.annotation.RetentionPolicy; + import java.lang.annotation.Target; + import software.amazon.lambda.powertools.parameters.transform.Transformer; + + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.FIELD) + public @interface CustomProviderParam { + // The parameter key + String key(); + + // The transformer to use + Class transformer() default Transformer.class; + } + ``` + +=== "CustomProviderAspect.java" + + ```java + @Aspect + public class CustomProviderAspect extends BaseParamAspect { + + @Pointcut("get(* *) && @annotation(ddbConfigParam)") + public void getParam(CustomProviderParam customConfigParam) { + } + + @Around("getParam(customConfigParam)") + public Object injectParam(final ProceedingJoinPoint joinPoint, final CustomProviderParam customConfigParam) { + System.out.println("GET IT"); + + BaseProvider provider = CustomProvider.builder().build(); + + return getAndTransform(customConfigParam.key(), ddbConfigParam.transformer(), provider, + (FieldSignature) joinPoint.getSignature()); + } + + } + ``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a8569f664..eb28caa7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -85,7 +85,7 @@ extra_javascript: extra: powertools: - version: 1.18.0 # to update after each release (we do not want snapshot version here) + version: 2.0.0-SNAPSHOT # to update after each release (we do not want snapshot version here) repo_url: https://github.com/aws-powertools/powertools-lambda-java edit_uri: edit/main/docs diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java index 59616e385..e38fddc84 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java @@ -25,6 +25,9 @@ import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; +/** + * Builder for the {@link SSMProvider} + */ public class SSMProviderBuilder { private SsmClient client; private CacheManager cacheManager; @@ -73,7 +76,7 @@ public SSMProviderBuilder withClient(SsmClient client) { } /** - * Mandatory. Provide a CacheManager to the {@link SSMProvider} + * Provide a CacheManager to the {@link SSMProvider} * * @param cacheManager the manager that will handle the cache of parameters * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) diff --git a/powertools-parameters/powertools-parameters-tests/pom.xml b/powertools-parameters/powertools-parameters-tests/pom.xml index a6a177393..d8e9b2a02 100644 --- a/powertools-parameters/powertools-parameters-tests/pom.xml +++ b/powertools-parameters/powertools-parameters-tests/pom.xml @@ -13,7 +13,7 @@ powertools-parameters-tests Powertools parameters tests that cut across all the parameters providers - + true @@ -21,16 +21,19 @@ software.amazon.lambda powertools-parameters-ssm + test ${project.version} software.amazon.lambda powertools-parameters-secrets + test ${project.version} software.amazon.lambda powertools-parameters-dynamodb + test ${project.version} diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java index c4a0ef391..e2b46599e 100644 --- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java +++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java @@ -137,7 +137,6 @@ public void get_customTTL_expired_shouldGetValue() { } @Test - // TODO Scott - remove this, or change to mutating the CacheManager first? public void get_customDefaultTTL_cached_shouldGetFromCache() { provider.cacheManager.setDefaultExpirationTime(Duration.of(12, MINUTES)); provider.get("foobar"); @@ -151,6 +150,7 @@ public void get_customDefaultTTL_cached_shouldGetFromCache() { @Test public void get_customDefaultTTL_expired_shouldGetValue() { + provider.cacheManager.setDefaultExpirationTime(Duration.of(2, MINUTES)); getFromStore = false; provider.setClock(offset(clock, of(3, MINUTES))); @@ -172,8 +172,10 @@ public void get_customDefaultTTLAndTTL_cached_shouldGetFromCache() { @Test public void get_customDefaultTTLAndTTL_expired_shouldGetValue() { - provider.withMaxAge(5, SECONDS) - .get("bariton"); + + provider.cacheManager.setDefaultExpirationTime(Duration.ofSeconds(5)); + + provider.get("bariton"); getFromStore = false; provider.setClock(offset(clock, of(6, SECONDS))); @@ -286,10 +288,11 @@ public void getObject_customDefaultTTL_cached_shouldGetFromCache() { } @Test - // TODO Scott public void getObject_customDefaultTTL_expired_shouldGetValue() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); + provider.cacheManager.setDefaultExpirationTime(Duration.of(2, MINUTES)); + provider.withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; @@ -301,11 +304,12 @@ public void getObject_customDefaultTTL_expired_shouldGetValue() { } @Test - // TODO Scott public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); - provider.withMaxAge(5, SECONDS) - .withTransformation(json) + + provider.cacheManager.setDefaultExpirationTime(Duration.ofSeconds(5)); + + provider.withTransformation(json) .get("foo", ObjectToDeserialize.class); getFromStore = false; @@ -316,10 +320,11 @@ public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() { } @Test - // TODO Scott public void getObject_customDefaultTTLAndTTL_expired_shouldGetValue() { provider.setValue("{\"foo\":\"Foo\", \"bar\":42, \"baz\":123456789}"); + provider.cacheManager.setDefaultExpirationTime(Duration.ofMinutes(2)); + provider.withMaxAge(5, SECONDS) .withTransformation(json) .get("foo", ObjectToDeserialize.class); From 23c7e1c367043c513e8337a896635f3e7fe70729 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 12:48:36 +0100 Subject: [PATCH 31/45] Incremental doc changes --- docs/utilities/parameters.md | 108 ++++++++++++++++++++++------------- 1 file changed, 69 insertions(+), 39 deletions(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 064d6e747..971b2c509 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -278,14 +278,13 @@ a different region or credentials, the former is simpler to use. === "Secrets Manager" - ```java hl_lines="13-16 20-25" + ```java hl_lines="12-15 19" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; import software.amazon.lambda.powertools.parameters.secrets.SecretsProvider; import com.amazonaws.services.lambda.runtime.RequestHandler; - import java.time.temporal.ChronoUnit; public class RequestHandlerWithParams implements RequestHandler { @@ -298,12 +297,7 @@ a different region or credentials, the former is simpler to use. public String handleRequest(String input, Context context) { // Retrieve a single secret - String value = secretsProvider - // Transform parameter from base64 - .withTransformation(base64) - // By default values are cached for 5 seconds, specify 10 seconds instead. - .withMaxAge(10, ChronoUnit.SECONDS) - .get("/my/secret"); + String value = secretsProvider.get("/my/secret"); // Because this is a secret, we probably don't want to return it! Return something indicating // we could access it instead. @@ -314,14 +308,13 @@ a different region or credentials, the former is simpler to use. === "Systems Manager" - ```java hl_lines="13-16 20-27" + ```java hl_lines="12-15 19-20 22" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; - import java.time.temporal.ChronoUnit; public class RequestHandlerWithParams implements RequestHandler { @@ -335,10 +328,6 @@ a different region or credentials, the former is simpler to use. public String handleRequest(String input, Context context) { // Retrieve a single secret String value = ssmProvider - // Transform parameter from base64 - .withTransformation(base64) - // By default values are cached for 5 seconds, specify 10 seconds instead. - .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); // We might instead want to retrieve multiple secrets at once, returning a Map of key/value pairs // .getMultiple("/my/secret/path"); @@ -351,14 +340,13 @@ a different region or credentials, the former is simpler to use. === "DynamoDB" - ```java hl_lines="13-16 20-27" + ```java hl_lines="12-15 19-20 22" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDbProvider; - import java.time.temporal.ChronoUnit; public class RequestHandlerWithParams implements RequestHandler { @@ -372,10 +360,6 @@ a different region or credentials, the former is simpler to use. public String handleRequest(String input, Context context) { // Retrieve a single secret String value = ddbProvider - // Transform parameter from base64 - .withTransformation(base64) - // By default values are cached for 5 seconds, specify 10 seconds instead. - .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); // We might instead want to retrieve multiple values at once, returning a Map of key/value pairs // .getMultiple("my-partition-key-value"); @@ -388,14 +372,13 @@ a different region or credentials, the former is simpler to use. === "AppConfig" - ```java hl_lines="13-16 20-25" + ```java hl_lines="12-15 19-20" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; - import java.time.temporal.ChronoUnit; public class RequestHandlerWithParams implements RequestHandler { @@ -409,10 +392,6 @@ a different region or credentials, the former is simpler to use. public String handleRequest(String input, Context context) { // Retrieve a single secret String value = appConfigProvider - // Transform parameter from base64 - .withTransformation(base64) - // By default values are cached for 5 seconds, specify 10 seconds instead. - .withMaxAge(10, ChronoUnit.SECONDS) .get("/my/secret"); // Return the result @@ -423,14 +402,38 @@ a different region or credentials, the former is simpler to use. ## Advanced configuration -### Default cache timeout -Each provider uses the CacheManager to cache parameter values. By default, values are cached for 5 seconds. If you -wish to customize this, you can provide a custom `CacheManager` to your provider with an appropriate timeout configured. -`CacheManager` instances can also be shared between providers. +### Caching +Each provider uses the CacheManager to cache parameter values. When a value is retrieved using from the provider, a +custom cache duration can be provided using `withMaxAge(duration, unit)`. + +If this is not specified, the default value set on the CacheManager itself will be used. This default can be customized +by calling `setDefaultExpirationTime(duration, unit)` on the CacheManager. -=== "Customize Cache" +=== "Customize Cache - Per Item" - ```java hl_lines="9 10 14 19" + ```java hl_lines="14 15" + import java.time.Duration; + import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; + import software.amazon.lambda.powertools.parameters.cache.CacheManager; + + public class CustomizeCacheTimeout { + + public void CustomizeCache() { + + AppConfigProvider paramProvider = AppConfigProvider + .builder() + .build(); + + // Cache for 20 seconds, rather than the default 5. + return paramProvider.withMaxAge(20, ChronoUnit.SECONDS) + .get("my-param"); + } + } + ``` + +=== "Customize Cache - Change Default" + + ```java hl_lines="9 10 14 19 22-25" import java.time.Duration; import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; @@ -448,9 +451,15 @@ wish to customize this, you can provide a custom `CacheManager` to your provider .withClient(AppConfigDataClient.builder().build()) .build(); - // We can override the default per `get` - paramProvider.withMaxAge(20, ChronoUnit.SECONDS) - .get("my-param"); + // Will use the default specified above - 10 seconds + String myParam1 = paramProvider.get("myParam1"); + + // Will override the default above + String myParam2 = paramProvider + .withMaxAge(20, ChronoUnit.SECONDS) + .get("myParam2"); + + return myParam2; } } ``` @@ -478,6 +487,10 @@ Base64 and JSON transformations are provided. For more complex transformation, y .get("/my/parameter/json", MyObj.class); ``` +### Decrypt Values + + + ### Create your own Transformer You can write your own transformer, by implementing the `Transformer` interface and the `applyTransformation()` method. @@ -485,7 +498,7 @@ For example, if you wish to deserialize XML into an object. === "XmlTransformer.java" - ```java hl_lines="1" + ```java public class XmlTransformer implements Transformer { private final XmlMapper mapper = new XmlMapper(); @@ -520,6 +533,10 @@ You can create your own custom parameter store provider by implementing a handfu import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; + /** + Our custom parameter provider itself. This does the heavy lifting of retrieving + parameters from whatever our underlying parameter store might be. + */ public class CustomProvider extends BaseProvider { public CustomProvider(CacheManager cacheManager, TransformationManager transformationManager) { @@ -545,14 +562,17 @@ You can create your own custom parameter store provider by implementing a handfu === "CustomProviderBuilder.java" ```java + /** + Provides a builder-style interface to configure our @{link CustomProvider}. + */ public class CustomProviderBuilder { private CacheManager cacheManager; private TransformationManager transformationManager; /** - * Create a {@link DynamoDbProvider} instance. + * Create a {@link CustomProvider} instance. * - * @return a {@link DynamoDbProvider} + * @return a {@link CustomProvider} */ public CustomProvider build() { if (cacheManager == null) { @@ -573,7 +593,7 @@ You can create your own custom parameter store provider by implementing a handfu } /** - * Provide a transformationManager to the {@link DynamoDbProvider} + * Provide a transformationManager to the {@link CustomProvider} * * @param transformationManager the manager that will handle transformation of parameters * @return the builder to chain calls (eg. 
builder.withTransformationManager().build()
) @@ -594,6 +614,11 @@ You can create your own custom parameter store provider by implementing a handfu import java.lang.annotation.Target; import software.amazon.lambda.powertools.parameters.transform.Transformer; + /** + Aspect to inject a parameter from our custom provider. Note that if you + want to implement a provider _without_ an Aspect and field injection, you can + skip implementing both this and the {@link CustomProviderAspect} class. + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface CustomProviderParam { @@ -608,6 +633,11 @@ You can create your own custom parameter store provider by implementing a handfu === "CustomProviderAspect.java" ```java + + /** + Aspect to inject a parameter from our custom provider where the {@link CustomProviderParam} + annotation is used. + */ @Aspect public class CustomProviderAspect extends BaseParamAspect { From 646bd54942dd28c48b068f6312feeac8932555a7 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 13:08:53 +0100 Subject: [PATCH 32/45] Cleanup --- docs/utilities/parameters.md | 174 ++++++++++++++++++++++------------- 1 file changed, 112 insertions(+), 62 deletions(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 971b2c509..23ccd5368 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -193,7 +193,13 @@ You can retrieve parameters either using annotations or by using the `xParamProv provider directly. The latter is useful if you need to configure the underlying SDK client, for example to use a different region or credentials, the former is simpler to use. -### Using Annotations +## Built-in provider classes + +This section describes the built-in provider classes for each parameter store, providing +examples showing how to inject parameters using annotations, and how to use the provider +interface. In cases where a provider supports extra features, these will also be described. + +### Secrets Manager === "Secrets Manager: @SecretsParam" @@ -216,66 +222,6 @@ a different region or credentials, the former is simpler to use. } ``` -=== "SSM Parameters Store: @SSMParam" - - ```java hl_lines="8 9" - import com.amazonaws.services.lambda.runtime.Context; - import com.amazonaws.services.lambda.runtime.RequestHandler; - import software.amazon.lambda.powertools.parameters.ssm.SSMParam; - - public class ParametersFunction implements RequestHandler { - - // Annotation-style injection from SSM Parameter Store - @SSMParam(key = "/powertools-java/param") - String ssmParam; - - public string handleRequest(String request, Context context) { - return ssmParam; // Request handler simply returns our configuration value - } - } - ``` - -=== "DynamoDB: @DyanmoDbParam" - - ```java hl_lines="8 9" - import com.amazonaws.services.lambda.runtime.Context; - import com.amazonaws.services.lambda.runtime.RequestHandler; - import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDBParam; - - public class ParametersFunction implements RequestHandler { - - // Annotation-style injection from DynamoDB - @DynamoDbParam(table = "my-test-tablename", key = "myKey") - String ddbParam; - - public string handleRequest(String request, Context context) { - return ddbParam; // Request handler simply returns our configuration value - } - } - ``` - -=== "AppConfig: @AppConfigParam" - - ```java hl_lines="8 9" - import com.amazonaws.services.lambda.runtime.Context; - import com.amazonaws.services.lambda.runtime.RequestHandler; - import software.amazon.lambda.powertools.parameters.appconfig.AppConfigParam; - - public class ParametersFunction implements RequestHandler { - - // Annotation-style injection from AppConfig - @AppConfigParam(application = "my-app", environment = "my-env", key = "myKey") - String appConfigParam; - - public string handleRequest(String request, Context context) { - return appConfigParam; // Request handler simply returns our configuration value - } - } - ``` - - -### Using the `ParamProvider` classes - === "Secrets Manager" ```java hl_lines="12-15 19" @@ -306,7 +252,36 @@ a different region or credentials, the former is simpler to use. } ``` -=== "Systems Manager" +### SSM Parameter Store + +The AWS Systems Manager Parameter Store provider supports two additional arguments for the `get()` and `getMultiple()` methods: + +| Option | Default | Description | +|---------------|---------|-------------| +| **withDecryption()** | `False` | Will automatically decrypt the parameter. | +| **recursive()** | `False` | For `getMultiple()` only, will fetch all parameter values recursively based on a path prefix. | + + +=== "SSM Parameter Store: @SSMParam" + + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import software.amazon.lambda.powertools.parameters.ssm.SSMParam; + + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from SSM Parameter Store + @SSMParam(key = "/powertools-java/param") + String ssmParam; + + public string handleRequest(String request, Context context) { + return ssmParam; // Request handler simply returns our configuration value + } + } + ``` + +=== "SSM" ```java hl_lines="12-15 19-20 22" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; @@ -338,6 +313,46 @@ a different region or credentials, the former is simpler to use. } ``` +=== "SSM: Additional Options" + + ```java hl_lines="9 12" + import software.amazon.lambda.powertools.parameters.SSMProvider; + import software.amazon.lambda.powertools.parameters.ParamManager; + + public class AppWithSSM implements RequestHandler { + // Get an instance of the SSM Provider + SSMProvider ssmProvider = ParamManager.getSsmProvider(); + + // Retrieve a single parameter and decrypt it + String value = ssmProvider.withDecryption().get("/my/parameter"); + + // Retrieve multiple parameters recursively from a path prefix + Map values = ssmProvider.recursive().getMultiple("/my/path/prefix"); + + } + ``` + +### DynamoDB + +=== "DynamoDB: @DyanmoDbParam" + + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import software.amazon.lambda.powertools.parameters.dynamodb.DynamoDBParam; + + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from DynamoDB + @DynamoDbParam(table = "my-test-tablename", key = "myKey") + String ddbParam; + + public string handleRequest(String request, Context context) { + return ddbParam; // Request handler simply returns our configuration value + } + } + ``` + === "DynamoDB" ```java hl_lines="12-15 19-20 22" @@ -370,6 +385,27 @@ a different region or credentials, the former is simpler to use. } ``` +### AppConfig + +=== "AppConfig: @AppConfigParam" + + ```java hl_lines="8 9" + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import software.amazon.lambda.powertools.parameters.appconfig.AppConfigParam; + + public class ParametersFunction implements RequestHandler { + + // Annotation-style injection from AppConfig + @AppConfigParam(application = "my-app", environment = "my-env", key = "myKey") + String appConfigParam; + + public string handleRequest(String request, Context context) { + return appConfigParam; // Request handler simply returns our configuration value + } + } + ``` + === "AppConfig" ```java hl_lines="12-15 19-20" @@ -522,6 +558,20 @@ For example, if you wish to deserialize XML into an object. .get("/my/parameter/xml", MyObj.class); ``` +### Fluent API + +To simplify the use of the library, you can chain all method calls before a get. + +=== "Fluent API call" + + ```java + ssmProvider + .defaultMaxAge(10, SECONDS) // will set 10 seconds as the default cache TTL + .withMaxAge(1, MINUTES) // will set the cache TTL for this value at 1 minute + .withTransformation(json) // json is a static import from Transformer.json + .withDecryption() // enable decryption of the parameter value + .get("/my/param", MyObj.class); // finally get the value + ### Create your own Provider You can create your own custom parameter store provider by implementing a handful of classes: From e994192135d23475f050975590829bf9dea88256 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 14:12:52 +0100 Subject: [PATCH 33/45] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> --- docs/utilities/parameters.md | 44 +++++++++++++++++------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 23ccd5368..38de7b5d3 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -222,7 +222,7 @@ interface. In cases where a provider supports extra features, these will also be } ``` -=== "Secrets Manager" +=== "Secrets Manager: SecretsProvider" ```java hl_lines="12-15 19" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; @@ -281,7 +281,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen } ``` -=== "SSM" +=== "SSM Parameter Store: SSMProvider" ```java hl_lines="12-15 19-20 22" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; @@ -313,7 +313,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen } ``` -=== "SSM: Additional Options" +=== "SSM Parameter Store: Additional Options" ```java hl_lines="9 12" import software.amazon.lambda.powertools.parameters.SSMProvider; @@ -353,7 +353,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen } ``` -=== "DynamoDB" +=== "DynamoDB: DynamoDbProvider" ```java hl_lines="12-15 19-20 22" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; @@ -406,7 +406,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen } ``` -=== "AppConfig" +=== "AppConfig: AppConfigProvider" ```java hl_lines="12-15 19-20" import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; @@ -439,11 +439,11 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen ## Advanced configuration ### Caching -Each provider uses the CacheManager to cache parameter values. When a value is retrieved using from the provider, a +Each provider uses the `CacheManager` to cache parameter values. When a value is retrieved using from the provider, a custom cache duration can be provided using `withMaxAge(duration, unit)`. -If this is not specified, the default value set on the CacheManager itself will be used. This default can be customized -by calling `setDefaultExpirationTime(duration, unit)` on the CacheManager. +If this is not specified, the default value set on the `CacheManager` itself will be used. This default can be customized +by calling `setDefaultExpirationTime(duration, unit)` on the `CacheManager`. === "Customize Cache - Per Item" @@ -523,11 +523,9 @@ Base64 and JSON transformations are provided. For more complex transformation, y .get("/my/parameter/json", MyObj.class); ``` -### Decrypt Values - -### Create your own Transformer +#### Create your own Transformer You can write your own transformer, by implementing the `Transformer` interface and the `applyTransformation()` method. For example, if you wish to deserialize XML into an object. @@ -584,9 +582,9 @@ You can create your own custom parameter store provider by implementing a handfu import software.amazon.lambda.powertools.parameters.transform.TransformationManager; /** - Our custom parameter provider itself. This does the heavy lifting of retrieving - parameters from whatever our underlying parameter store might be. - */ + * Our custom parameter provider itself. This does the heavy lifting of retrieving + * parameters from whatever our underlying parameter store might be. + **/ public class CustomProvider extends BaseProvider { public CustomProvider(CacheManager cacheManager, TransformationManager transformationManager) { @@ -613,8 +611,8 @@ You can create your own custom parameter store provider by implementing a handfu ```java /** - Provides a builder-style interface to configure our @{link CustomProvider}. - */ + * Provides a builder-style interface to configure our @{link CustomProvider}. + **/ public class CustomProviderBuilder { private CacheManager cacheManager; private TransformationManager transformationManager; @@ -665,10 +663,10 @@ You can create your own custom parameter store provider by implementing a handfu import software.amazon.lambda.powertools.parameters.transform.Transformer; /** - Aspect to inject a parameter from our custom provider. Note that if you - want to implement a provider _without_ an Aspect and field injection, you can - skip implementing both this and the {@link CustomProviderAspect} class. - */ + * Aspect to inject a parameter from our custom provider. Note that if you + * want to implement a provider _without_ an Aspect and field injection, you can + * skip implementing both this and the {@link CustomProviderAspect} class. + **/ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface CustomProviderParam { @@ -685,9 +683,9 @@ You can create your own custom parameter store provider by implementing a handfu ```java /** - Aspect to inject a parameter from our custom provider where the {@link CustomProviderParam} - annotation is used. - */ + * Aspect to inject a parameter from our custom provider where the {@link CustomProviderParam} + * annotation is used. + **/ @Aspect public class CustomProviderAspect extends BaseParamAspect { From 19fc9880c39f3c67571e0edc62e53f40ac81989b Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 14:27:43 +0100 Subject: [PATCH 34/45] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> --- .../parameters/appconfig/AppConfigProviderBuilder.java | 2 +- .../powertools/parameters/dynamodb/DynamoDbParamAspect.java | 3 +-- .../powertools/parameters/dynamodb/DynamoDbProvider.java | 2 +- .../powertools/parameters/secrets/SecretsParamAspect.java | 3 +-- .../lambda/powertools/parameters/ssm/SSMParamAspect.java | 1 - 5 files changed, 4 insertions(+), 7 deletions(-) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java index 38df99c4e..ef93dfa81 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java @@ -63,7 +63,7 @@ public AppConfigProvider build() { } /** - * Set custom {@link AppConfigProvider} to pass to the {@link AppConfigDataClient}.
+ * Set custom {@link AppConfigDataClient} to pass to the {@link AppConfigProvider}.
* Use it if you want to customize the region or any other part of the client. * * @param client Custom client diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java index d3b49e021..1aa022cbd 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParamAspect.java @@ -24,7 +24,7 @@ import software.amazon.lambda.powertools.parameters.BaseProvider; /** - * Provides the DynamoDB parameter aspect. This aspect is responsible for injecting + * Provides the Amazon DynamoDB parameter aspect. This aspect is responsible for injecting * parameters from DynamoDB into fields annotated with @DynamoDbParam. See the * README and Powertools for Lambda (Java) documentation for information on using this feature. */ @@ -42,7 +42,6 @@ public void getParam(DynamoDbParam ddbConfigParam) { @Around("getParam(ddbConfigParam)") public Object injectParam(final ProceedingJoinPoint joinPoint, final DynamoDbParam ddbConfigParam) { - System.out.println("GET IT"); BaseProvider provider = providerBuilder.apply(ddbConfigParam.table()); return getAndTransform(ddbConfigParam.key(), ddbConfigParam.transformer(), provider, diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java index adf316fc3..4a1476e38 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java @@ -30,7 +30,7 @@ import software.amazon.lambda.powertools.parameters.transform.TransformationManager; /** - * Implements a {@link ParamProvider} on top of DynamoDB. The schema of the table + * Implements a {@link ParamProvider} on top of Amazon DynamoDB. The schema of the table * is described in the Powertools for AWS Lambda (Java) documentation. * * @see Parameters provider documentation diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java index 8e897762d..748c88cc9 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParamAspect.java @@ -24,7 +24,7 @@ /** * Provides the Secrets parameter aspect. This aspect is responsible for injecting - * parameters from Secrets Provider into fields annotated with @SecretsParam. See the + * parameters from AWS Secrets Manager into fields annotated with @SecretsParam. See the * README and Powertools for Lambda (Java) documentation for information on using this feature. */ @Aspect @@ -39,7 +39,6 @@ public void getParam(SecretsParam secretsParam) { @Around("getParam(secretsParam)") public Object injectParam(final ProceedingJoinPoint joinPoint, final SecretsParam secretsParam) { - System.out.println("GET IT"); SecretsProvider provider = providerBuilder.get(); return getAndTransform(secretsParam.key(), secretsParam.transformer(), provider, diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java index 3d238149e..b4d370506 100644 --- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java +++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParamAspect.java @@ -40,7 +40,6 @@ public void getParam(SSMParam secretsParam) { @Around("getParam(ssmPaam)") public Object injectParam(final ProceedingJoinPoint joinPoint, final SSMParam ssmPaam) { - System.out.println("GET IT"); SSMProvider provider = providerBuilder.get(); return getAndTransform(ssmPaam.key(), ssmPaam.transformer(), provider, From 8fee25b4337c63f491301a0e43bd0dc4675e470e Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 8 Dec 2023 14:27:55 +0100 Subject: [PATCH 35/45] Review feedback --- docs/utilities/parameters.md | 5 +--- mkdocs.yml | 2 +- powertools-parameters/pom.xml | 23 ------------------- .../powertools-parameters-appconfig/pom.xml | 22 ------------------ .../appconfig/AppConfigProviderBuilder.java | 6 ++++- .../appconfig/AppConfigProviderTest.java | 10 ++++---- .../powertools-parameters-dynamodb/pom.xml | 22 ------------------ .../dynamodb/DynamoDbProviderBuilder.java | 6 ++++- .../powertools-parameters-secrets/pom.xml | 22 ------------------ .../parameters/secrets/SecretsProvider.java | 2 +- .../secrets/SecretsProviderBuilder.java | 6 ++++- .../powertools-parameters-ssm/pom.xml | 22 ------------------ .../parameters/ssm/SSMProvider.java | 4 ++-- .../parameters/ssm/SSMProviderBuilder.java | 1 - .../parameters/BaseProviderTest.java | 5 ++-- .../ParamProvidersIntegrationTest.java | 2 -- powertools-parameters/spotbugs-exclude.xml | 13 ----------- 17 files changed, 29 insertions(+), 144 deletions(-) diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 38de7b5d3..3084dd58d 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -564,7 +564,6 @@ To simplify the use of the library, you can chain all method calls before a get. ```java ssmProvider - .defaultMaxAge(10, SECONDS) // will set 10 seconds as the default cache TTL .withMaxAge(1, MINUTES) // will set the cache TTL for this value at 1 minute .withTransformation(json) // json is a static import from Transformer.json .withDecryption() // enable decryption of the parameter value @@ -694,9 +693,7 @@ You can create your own custom parameter store provider by implementing a handfu } @Around("getParam(customConfigParam)") - public Object injectParam(final ProceedingJoinPoint joinPoint, final CustomProviderParam customConfigParam) { - System.out.println("GET IT"); - + public Object injectParam(final ProceedingJoinPoint joinPoint, final CustomProviderParam customConfigParam) { BaseProvider provider = CustomProvider.builder().build(); return getAndTransform(customConfigParam.key(), ddbConfigParam.transformer(), provider, diff --git a/mkdocs.yml b/mkdocs.yml index eb28caa7a..b7f793e18 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -85,7 +85,7 @@ extra_javascript: extra: powertools: - version: 2.0.0-SNAPSHOT # to update after each release (we do not want snapshot version here) + version: 2.0.0 # to update after each release (we do not want snapshot version here) repo_url: https://github.com/aws-powertools/powertools-lambda-java edit_uri: edit/main/docs diff --git a/powertools-parameters/pom.xml b/powertools-parameters/pom.xml index 64952408b..1bc662457 100644 --- a/powertools-parameters/pom.xml +++ b/powertools-parameters/pom.xml @@ -30,29 +30,6 @@ Set of utilities to retrieve parameters - common interface - https://aws.amazon.com/lambda/ - - GitHub Issues - https://github.com/aws-powertools/powertools-lambda-java/issues - - - https://github.com/aws-powertools/powertools-lambda-java.git - - - - Powertools for AWS Lambda team - Amazon Web Services - https://aws.amazon.com/ - - - - - - ossrh - https://aws.oss.sonatype.org/content/repositories/snapshots - - - software.amazon.lambda diff --git a/powertools-parameters/powertools-parameters-appconfig/pom.xml b/powertools-parameters/powertools-parameters-appconfig/pom.xml index d44308f6b..3a3018c7c 100644 --- a/powertools-parameters/powertools-parameters-appconfig/pom.xml +++ b/powertools-parameters/powertools-parameters-appconfig/pom.xml @@ -15,28 +15,6 @@ Powertools for AWS Lambda (Java) library Parameters - AppConfig AppConfig implementation for the Parameters module - - GitHub Issues - https://github.com/aws-powertools/powertools-lambda-java/issues - - - https://github.com/aws-powertools/powertools-lambda-java.git - - - - Powertools for AWS Lambda team - Amazon Web Services - https://aws.amazon.com/ - - - - - - ossrh - https://aws.oss.sonatype.org/content/repositories/snapshots - - - software.amazon.lambda diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java index 38df99c4e..691df7ca9 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderBuilder.java @@ -22,9 +22,13 @@ import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; +/** + * Implements a {@link ParamProvider} on top of the AppConfig service. AppConfig provides + */ public class AppConfigProviderBuilder { private AppConfigDataClient client; private CacheManager cacheManager; @@ -97,7 +101,7 @@ public AppConfigProviderBuilder withApplication(String application) { } /** - * Mandatory. Provide a CacheManager to the {@link AppConfigProvider} + * Provide a CacheManager to the {@link AppConfigProvider} * * @param cacheManager the manager that will handle the cache of parameters * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java index a7a46e05e..7cbf7256b 100644 --- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java +++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java @@ -14,7 +14,9 @@ package software.amazon.lambda.powertools.parameters.appconfig; -import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalStateException; +import static org.assertj.core.api.Assertions.assertThatRuntimeException; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; @@ -188,7 +190,7 @@ public void multipleKeysRetrievalWorks() { public void getMultipleValuesThrowsException() { // Act & Assert - Assertions.assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) + assertThatRuntimeException().isThrownBy(() -> provider.getMultipleValues("path")) .withMessage("Retrieving multiple parameter values is not supported with the AWS App Config Provider"); } @@ -196,7 +198,7 @@ public void getMultipleValuesThrowsException() { public void testAppConfigProviderBuilderMissingEnvironment_throwsException() { // Act & Assert - Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() + assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() .withCacheManager(new CacheManager()) .withApplication(applicationName) .withClient(client) @@ -208,7 +210,7 @@ public void testAppConfigProviderBuilderMissingEnvironment_throwsException() { public void testAppConfigProviderBuilderMissingApplication_throwsException() { // Act & Assert - Assertions.assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() + assertThatIllegalStateException().isThrownBy(() -> AppConfigProvider.builder() .withCacheManager(new CacheManager()) .withEnvironment(environmentName) .withClient(client) diff --git a/powertools-parameters/powertools-parameters-dynamodb/pom.xml b/powertools-parameters/powertools-parameters-dynamodb/pom.xml index 64fbea0fd..ad32bdff8 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/pom.xml +++ b/powertools-parameters/powertools-parameters-dynamodb/pom.xml @@ -15,28 +15,6 @@ Powertools for AWS Lambda (Java) library Parameters - DynamoDB DynamoDB implementation for the Parameters module - - GitHub Issues - https://github.com/aws-powertools/powertools-lambda-java/issues - - - https://github.com/aws-powertools/powertools-lambda-java.git - - - - Powertools for AWS Lambda team - Amazon Web Services - https://aws.amazon.com/ - - - - - - ossrh - https://aws.oss.sonatype.org/content/repositories/snapshots - - - software.amazon.lambda diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java index 66e33c70d..6b6610ba1 100644 --- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java +++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProviderBuilder.java @@ -22,9 +22,13 @@ import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator; import software.amazon.lambda.powertools.parameters.BaseProvider; +import software.amazon.lambda.powertools.parameters.ParamProvider; import software.amazon.lambda.powertools.parameters.cache.CacheManager; import software.amazon.lambda.powertools.parameters.transform.TransformationManager; +/** + * Implements a {@link ParamProvider} on top of the DynamoDB service. DynamoDB provides + */ public class DynamoDbProviderBuilder { private DynamoDbClient client; private String table; @@ -75,7 +79,7 @@ public DynamoDbProviderBuilder withClient(DynamoDbClient client) { } /** - * Mandatory. Provide a CacheManager to the {@link DynamoDbProvider} + * Provide a CacheManager to the {@link DynamoDbProvider} * * @param cacheManager the manager that will handle the cache of parameters * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
) diff --git a/powertools-parameters/powertools-parameters-secrets/pom.xml b/powertools-parameters/powertools-parameters-secrets/pom.xml index 0896d9646..6c4501ca3 100644 --- a/powertools-parameters/powertools-parameters-secrets/pom.xml +++ b/powertools-parameters/powertools-parameters-secrets/pom.xml @@ -15,28 +15,6 @@ Powertools for AWS Lambda (Java) library Parameters - Secrets Manager Secrets Manager implementation for the Parameters module - - GitHub Issues - https://github.com/aws-powertools/powertools-lambda-java/issues - - - https://github.com/aws-powertools/powertools-lambda-java.git - - - - Powertools for AWS Lambda team - Amazon Web Services - https://aws.amazon.com/ - - - - - - ossrh - https://aws.oss.sonatype.org/content/repositories/snapshots - - - software.amazon.lambda diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java index 6fe6194f3..b17fd91c7 100644 --- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java +++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java @@ -29,7 +29,7 @@ * * Samples: * 
- *     SecretsProvider provider = ParamManager.getSecretsProvider();
+ *     SecretsProvider provider = SecretsProvider.builder().build();
  *
  *     String value = provider.get("key");
  *     System.out.println(value);
diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java
index 3b13d0c37..125425200 100644
--- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java
+++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProviderBuilder.java
@@ -22,9 +22,13 @@
 import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient;
 import software.amazon.lambda.powertools.common.internal.UserAgentConfigurator;
 import software.amazon.lambda.powertools.parameters.BaseProvider;
+import software.amazon.lambda.powertools.parameters.ParamProvider;
 import software.amazon.lambda.powertools.parameters.cache.CacheManager;
 import software.amazon.lambda.powertools.parameters.transform.TransformationManager;
 
+/**
+ * Implements a {@link ParamProvider} on top of the SecretsManager service. SecretsManager provides
+ */
 public class SecretsProviderBuilder {
 
     private SecretsManagerClient client;
@@ -74,7 +78,7 @@ public SecretsProviderBuilder withClient(SecretsManagerClient client) {
     }
 
     /**
-     * Mandatory. Provide a CacheManager to the {@link SecretsProvider}
+     * Provide a CacheManager to the {@link SecretsProvider}
      *
      * @param cacheManager the manager that will handle the cache of parameters
      * @return the builder to chain calls (eg. 
builder.withCacheManager().build()
)
diff --git a/powertools-parameters/powertools-parameters-ssm/pom.xml b/powertools-parameters/powertools-parameters-ssm/pom.xml
index dce95ae02..80276189d 100644
--- a/powertools-parameters/powertools-parameters-ssm/pom.xml
+++ b/powertools-parameters/powertools-parameters-ssm/pom.xml
@@ -15,28 +15,6 @@
     Powertools for AWS Lambda (Java) library Parameters - SSM
     SSM Parameter Store implementation for the Parameters module
 
-    
-        GitHub Issues
-        https://github.com/aws-powertools/powertools-lambda-java/issues
-    
-    
-        https://github.com/aws-powertools/powertools-lambda-java.git
-    
-    
-        
-            Powertools for AWS Lambda team
-            Amazon Web Services
-            https://aws.amazon.com/
-        
-    
-
-    
-        
-            ossrh
-            https://aws.oss.sonatype.org/content/repositories/snapshots
-        
-    
-
     
         
             software.amazon.lambda
diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
index 3a88c90be..d60cd8aee 100644
--- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
+++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
@@ -30,7 +30,7 @@
  *
  * Samples:
  * 
- *     SSMProvider provider = ParamManager.getSsmProvider();
+ *     SSMProvider provider = SSMProvider.builder().build();
  *
  *     String value = provider.get("key");
  *     System.out.println(value);
@@ -166,7 +166,7 @@ private Map getMultipleBis(String path, String nextToken) {
             res.parameters().forEach(parameter ->
             {
                 /* Standardize the parameter name
-                   The parameter name returned by SSM will contained the full path.
+                   The parameter name returned by SSM will contain the full path.
                    However, for readability, we should return only the part after
                    the path.
                  */
diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java
index e38fddc84..3b4fff1b3 100644
--- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java
+++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProviderBuilder.java
@@ -50,7 +50,6 @@ private static SsmClient createClient() {
      */
     public SSMProvider build() {
         if (cacheManager == null) {
-            // TODO - do we want to share this somehow?
             cacheManager = new CacheManager();
         }
         SSMProvider provider;
diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java
index e2b46599e..5fa740253 100644
--- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java
+++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/BaseProviderTest.java
@@ -173,9 +173,9 @@ public void get_customDefaultTTLAndTTL_cached_shouldGetFromCache() {
     @Test
     public void get_customDefaultTTLAndTTL_expired_shouldGetValue() {
 
-        provider.cacheManager.setDefaultExpirationTime(Duration.ofSeconds(5));
+        provider.cacheManager.setDefaultExpirationTime(Duration.ofMinutes(2));
 
-        provider.get("bariton");
+        provider.withMaxAge(5, SECONDS).get("bariton");
         getFromStore = false;
 
         provider.setClock(offset(clock, of(6, SECONDS)));
@@ -310,6 +310,7 @@ public void getObject_customDefaultTTLAndTTL_cached_shouldGetFromCache() {
         provider.cacheManager.setDefaultExpirationTime(Duration.ofSeconds(5));
 
         provider.withTransformation(json)
+                .withMaxAge(5, SECONDS)
                 .get("foo", ObjectToDeserialize.class);
         getFromStore = false;
 
diff --git a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java
index fe7b66959..7d790d140 100644
--- a/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java
+++ b/powertools-parameters/powertools-parameters-tests/src/test/java/software/amazon/lambda/powertools/parameters/ParamProvidersIntegrationTest.java
@@ -62,8 +62,6 @@ public class ParamProvidersIntegrationTest {
     @BeforeEach
     public void setup() throws IllegalAccessException {
         openMocks(this);
-
-        //writeStaticField(ParamManager.class, "providers", new ConcurrentHashMap<>(), true);
     }
 
     @Test
diff --git a/powertools-parameters/spotbugs-exclude.xml b/powertools-parameters/spotbugs-exclude.xml
index 5903492f3..d48e9bee1 100644
--- a/powertools-parameters/spotbugs-exclude.xml
+++ b/powertools-parameters/spotbugs-exclude.xml
@@ -79,17 +79,4 @@
 
         
     
-    
-        
-        
-            
-                
-                
-            
-            
-                
-                
-            
-        
-    
 
\ No newline at end of file

From f356ab47358824bfd928f9a297f2367fece5c3f4 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:00:42 +0100
Subject: [PATCH 36/45] More review changes

---
 docs/utilities/parameters.md                  |  4 +---
 .../parameters/appconfig/AppConfigParam.java  |  5 +++++
 .../appconfig/AppConfigProvider.java          |  7 +++++++
 .../parameters/dynamodb/DynamoDbParam.java    | 20 +++++++++++++++++++
 .../parameters/dynamodb/DynamoDbProvider.java |  7 +++++++
 .../parameters/secrets/SecretsParam.java      | 17 ++++++++++++++++
 .../parameters/secrets/SecretsProvider.java   |  7 +++++++
 .../powertools/parameters/ssm/SSMParam.java   | 18 +++++++++++++++++
 .../parameters/ssm/SSMProvider.java           |  7 +++++++
 9 files changed, 89 insertions(+), 3 deletions(-)

diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md
index 3084dd58d..7771a7942 100644
--- a/docs/utilities/parameters.md
+++ b/docs/utilities/parameters.md
@@ -456,9 +456,7 @@ by calling `setDefaultExpirationTime(duration, unit)` on the `CacheManager`.
         
         public void CustomizeCache() {
     
-            AppConfigProvider paramProvider = AppConfigProvider
-                    .builder()
-                    .build();
+            AppConfigProvider paramProvider = AppConfigProvider.create();
     
             // Cache for 20 seconds, rather than the default 5.
             return paramProvider.withMaxAge(20, ChronoUnit.SECONDS)
diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java
index 32ba97a2e..eb959be76 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParam.java
@@ -29,6 +29,11 @@
  * @see AppConfigProviderBuilder
  * @see Powertools for AWS Lambda (Java) parameters documentation
+ *
+ * 
+ * @AppConfigParam(key = "my-param", environment = "my-env", application = "my-app")
+ * String appConfigParam;
+ * 

  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
index d884e4512..e157aafeb 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
@@ -63,6 +63,13 @@ public static AppConfigProviderBuilder builder() {
         return new AppConfigProviderBuilder();
     }
 
+    /**
+     * Create a AppConfigProvider with all default settings.
+     */
+    public static AppConfigProvider create() {
+        return new AppConfigProviderBuilder().build();
+    }
+
     /**
      * Retrieve the parameter value from the AppConfig parameter store.

      *
diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
index 45c3b83aa..f1ba4fe8a 100644
--- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
+++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
@@ -20,12 +20,32 @@
 import java.lang.annotation.Target;
 import software.amazon.lambda.powertools.parameters.transform.Transformer;
 
+/**
+ * Inject a parameter from the DynamoDB Parameter Store into a field. You can also use
+ * {@code DynamoDbProviderBuilder} to obtain DynamoDB values directly, rather than injecting them implicitly.
+ *
+ * Usage:
+ * 
+ * @SSMParam(key = "my-param", table = "my-table")
+ * String myParameter;
+ * 

+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface DynamoDbParam {
+    /**
+     * Mandatory. Partition key from the DynamoDB table
+     */
     String key();
 
+    /**
+     * Mandatory. Table name for the DynamoDB table
+     * @return
+     */
     String table();
 
+    /**
+     * Optional Provide a Transformer to transform the returned parameter values.
+     */
     Class transformer() default Transformer.class;
 }
diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
index 4a1476e38..add68e317 100644
--- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
+++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
@@ -56,6 +56,13 @@ public static DynamoDbProviderBuilder builder() {
         return new DynamoDbProviderBuilder();
     }
 
+    /**
+     * Create a DynamoDbProvider with all default settings.
+     */
+    public static DynamoDbProvider create() {
+        return new DynamoDbProviderBuilder().build();
+    }
+
     /**
      * Return a single value from the DynamoDB parameter provider.
      *
diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java
index a9e7f5646..f9c110c49 100644
--- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java
+++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsParam.java
@@ -20,10 +20,27 @@
 import java.lang.annotation.Target;
 import software.amazon.lambda.powertools.parameters.transform.Transformer;
 
+/**
+ * Inject a parameter from the Secrets Manager into a field. You can also use
+ * {@code SecretsProviderBuilder} to obtain Secrets Manager values directly, rather than
+ * injecting them implicitly.
+ *
+ * 
+ * @SecretsParam(key = "my-secret")
+ * String mySecret;
+ * 

+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface SecretsParam {
+    /**
+     * Mandatory. key from the secrets manager store.
+     * @return
+     */
     String key();
 
+    /**
+     * Optional. a transfer to apply to the value
+     */
     Class transformer() default Transformer.class;
 }
diff --git a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java
index b17fd91c7..9087c1ad6 100644
--- a/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java
+++ b/powertools-parameters/powertools-parameters-secrets/src/main/java/software/amazon/lambda/powertools/parameters/secrets/SecretsProvider.java
@@ -72,6 +72,13 @@ public static SecretsProviderBuilder builder() {
         return new SecretsProviderBuilder();
     }
 
+    /**
+     * Create a SecretsProvider with all default settings.
+     */
+    public static SecretsProvider create() {
+        return new SecretsProviderBuilder().build();
+    }
+
     /**
      * Retrieve the parameter value from the AWS Secrets Manager.
      *
diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java
index ced673829..9b1587bb4 100644
--- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java
+++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMParam.java
@@ -20,10 +20,28 @@
 import java.lang.annotation.Target;
 import software.amazon.lambda.powertools.parameters.transform.Transformer;
 
+/**
+ * Inject a parameter from the SSM Parameter Store into a field. You can also use
+ * {@code SSMProviderBuilder} to obtain SSM values directly, rather than injecting them implicitly.
+ *
+ * Usage:
+ * 
+ * @SSMParam(key = "/my/parameter")
+ * String myParameter;
+ * 

+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface SSMParam {
+    /**
+     * Mandatory. Key from the SSM parameter store
+     * @return
+     */
     String key();
 
+
+    /**
+     * Optional. a transfer to apply to the value
+     */
     Class transformer() default Transformer.class;
 }
diff --git a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
index d60cd8aee..c24b08b84 100644
--- a/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
+++ b/powertools-parameters/powertools-parameters-ssm/src/main/java/software/amazon/lambda/powertools/parameters/ssm/SSMProvider.java
@@ -92,6 +92,13 @@ public static SSMProviderBuilder builder() {
         return new SSMProviderBuilder();
     }
 
+    /**
+     * Create a SSMProvider with all default settings.
+     */
+    public static SSMProvider create() {
+        return new SSMProviderBuilder().build();
+    }
+
     /**
      * Retrieve the parameter value from the AWS System Manager Parameter Store.
      *

From 4a5cecf733b147e3e962a8198dc3c3d59dbda700 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:01:41 +0100
Subject: [PATCH 37/45] Update
 powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com>
---
 .../parameters/appconfig/AppConfigParametersAspect.java         | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java
index b151da6e0..7ab4cf23e 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigParametersAspect.java
@@ -24,7 +24,7 @@
 
 /**
  * Provides the AppConfig parameter aspect. This aspect is responsible for injecting
- * parameters from AppConfig into fields annotated with @AppConfigParam. See the
+ * parameters from AWS AppConfig into fields annotated with @AppConfigParam. See the
  * README and Powertools for Lambda (Java) documentation for information on using this feature.
  */
 @Aspect

From f27b69f72fc9d87b0020262cb137ece179ca5ab7 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:09:01 +0100
Subject: [PATCH 38/45] E2E tests fix

---
 powertools-e2e-tests/handlers/batch/pom.xml                | 2 +-
 powertools-e2e-tests/handlers/idempotency/pom.xml          | 2 +-
 powertools-e2e-tests/handlers/largemessage/pom.xml         | 2 +-
 .../handlers/largemessage_idempotent/pom.xml               | 2 +-
 powertools-e2e-tests/handlers/logging/pom.xml              | 2 +-
 powertools-e2e-tests/handlers/metrics/pom.xml              | 2 +-
 powertools-e2e-tests/handlers/parameters/pom.xml           | 2 +-
 .../software/amazon/lambda/powertools/e2e/Function.java    | 7 ++++++-
 powertools-e2e-tests/handlers/pom.xml                      | 2 +-
 powertools-e2e-tests/handlers/tracing/pom.xml              | 2 +-
 powertools-e2e-tests/handlers/validation-alb-event/pom.xml | 2 +-
 .../handlers/validation-apigw-event/pom.xml                | 2 +-
 .../powertools/parameters/appconfig/AppConfigProvider.java | 6 ------
 13 files changed, 17 insertions(+), 18 deletions(-)

diff --git a/powertools-e2e-tests/handlers/batch/pom.xml b/powertools-e2e-tests/handlers/batch/pom.xml
index aee9bf3dd..ccb9926f1 100644
--- a/powertools-e2e-tests/handlers/batch/pom.xml
+++ b/powertools-e2e-tests/handlers/batch/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-batch
diff --git a/powertools-e2e-tests/handlers/idempotency/pom.xml b/powertools-e2e-tests/handlers/idempotency/pom.xml
index 22b6a1c53..f033fce24 100644
--- a/powertools-e2e-tests/handlers/idempotency/pom.xml
+++ b/powertools-e2e-tests/handlers/idempotency/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-idempotency
diff --git a/powertools-e2e-tests/handlers/largemessage/pom.xml b/powertools-e2e-tests/handlers/largemessage/pom.xml
index 8302624ef..e6539f4fe 100644
--- a/powertools-e2e-tests/handlers/largemessage/pom.xml
+++ b/powertools-e2e-tests/handlers/largemessage/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-largemessage
diff --git a/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml b/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
index 1fe9092ef..5e7f026bf 100644
--- a/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
+++ b/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-large-msg-idempotent
diff --git a/powertools-e2e-tests/handlers/logging/pom.xml b/powertools-e2e-tests/handlers/logging/pom.xml
index 05e91d8e3..86c149f45 100644
--- a/powertools-e2e-tests/handlers/logging/pom.xml
+++ b/powertools-e2e-tests/handlers/logging/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-logging
diff --git a/powertools-e2e-tests/handlers/metrics/pom.xml b/powertools-e2e-tests/handlers/metrics/pom.xml
index 2f3cabd16..ce5e934d8 100644
--- a/powertools-e2e-tests/handlers/metrics/pom.xml
+++ b/powertools-e2e-tests/handlers/metrics/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-metrics
diff --git a/powertools-e2e-tests/handlers/parameters/pom.xml b/powertools-e2e-tests/handlers/parameters/pom.xml
index 4d5330da0..0b8c5d118 100644
--- a/powertools-e2e-tests/handlers/parameters/pom.xml
+++ b/powertools-e2e-tests/handlers/parameters/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-parameters
diff --git a/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java b/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
index 3a83a1b05..016844117 100644
--- a/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
+++ b/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
@@ -24,7 +24,12 @@ public class Function implements RequestHandler {
 
     @Logging
     public String handleRequest(Input input, Context context) {
-        AppConfigProvider provider = ParamManager.getAppConfigProvider(input.getEnvironment(), input.getApp());
+        AppConfigProvider provider = AppConfigProvider.builder()
+                .withApplication(input.getApp())
+                .withEnvironment(input.getEnvironment())
+                .build();
+
+        //(input.getEnvironment(), input.getApp());
         return provider.get(input.getKey());
 
     }
diff --git a/powertools-e2e-tests/handlers/pom.xml b/powertools-e2e-tests/handlers/pom.xml
index 7c1208470..f27634feb 100644
--- a/powertools-e2e-tests/handlers/pom.xml
+++ b/powertools-e2e-tests/handlers/pom.xml
@@ -4,7 +4,7 @@
 
     software.amazon.lambda
     e2e-test-handlers-parent
-    1.0.0
+    2.0.0
     pom
     Handlers for End-to-End tests
     Fake handlers that use Powertools for AWS Lambda (Java).
diff --git a/powertools-e2e-tests/handlers/tracing/pom.xml b/powertools-e2e-tests/handlers/tracing/pom.xml
index b9240c356..b1bc14c05 100644
--- a/powertools-e2e-tests/handlers/tracing/pom.xml
+++ b/powertools-e2e-tests/handlers/tracing/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-tracing
diff --git a/powertools-e2e-tests/handlers/validation-alb-event/pom.xml b/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
index 31570fe4e..36695b9a4 100644
--- a/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
+++ b/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-validation-alb-event
diff --git a/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml b/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
index 9129abc7d..8bb927778 100644
--- a/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
+++ b/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        1.0.0
+        2.0.0
     
 
     e2e-test-handler-validation-apigw-event
diff --git a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
index e157aafeb..5fd272c9b 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/main/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProvider.java
@@ -63,12 +63,6 @@ public static AppConfigProviderBuilder builder() {
         return new AppConfigProviderBuilder();
     }
 
-    /**
-     * Create a AppConfigProvider with all default settings.
-     */
-    public static AppConfigProvider create() {
-        return new AppConfigProviderBuilder().build();
-    }
 
     /**
      * Retrieve the parameter value from the AppConfig parameter store.


From dccd961729facc15de710d3488fad0b8ce463194 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:14:56 +0100
Subject: [PATCH 39/45] A final change?

---
 docs/utilities/parameters.md | 22 +---------------------
 1 file changed, 1 insertion(+), 21 deletions(-)

diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md
index 7771a7942..607791a82 100644
--- a/docs/utilities/parameters.md
+++ b/docs/utilities/parameters.md
@@ -445,27 +445,7 @@ custom cache duration can be provided using `withMaxAge(duration, unit)`.
 If this is not specified, the default value set on the `CacheManager` itself will be used. This default can be customized
 by calling `setDefaultExpirationTime(duration, unit)` on the `CacheManager`.
 
-=== "Customize Cache - Per Item"
-
-    ```java hl_lines="14 15"
-    import java.time.Duration;
-    import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider;
-    import software.amazon.lambda.powertools.parameters.cache.CacheManager;
-    
-    public class CustomizeCacheTimeout {
-        
-        public void CustomizeCache() {
-    
-            AppConfigProvider paramProvider = AppConfigProvider.create();
-    
-            // Cache for 20 seconds, rather than the default 5.
-            return paramProvider.withMaxAge(20, ChronoUnit.SECONDS)
-                    .get("my-param");
-        }
-    }
-    ```
-
-=== "Customize Cache - Change Default"
+=== "Customize Cache"
 
     ```java hl_lines="9 10 14 19 22-25"
     import java.time.Duration;

From fab773e04c308ca1e8406f00e196c989f7e6d36a Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:25:02 +0100
Subject: [PATCH 40/45] Removed useless create

---
 .../powertools/parameters/dynamodb/DynamoDbProvider.java   | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
index add68e317..4a1476e38 100644
--- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
+++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbProvider.java
@@ -56,13 +56,6 @@ public static DynamoDbProviderBuilder builder() {
         return new DynamoDbProviderBuilder();
     }
 
-    /**
-     * Create a DynamoDbProvider with all default settings.
-     */
-    public static DynamoDbProvider create() {
-        return new DynamoDbProviderBuilder().build();
-    }
-
     /**
      * Return a single value from the DynamoDB parameter provider.
      *

From f7e1a24a35348cc3223579080c64a3c92d9f5c98 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 15:51:02 +0100
Subject: [PATCH 41/45] Will this do it?

---
 powertools-e2e-tests/handlers/parameters/pom.xml | 2 +-
 powertools-e2e-tests/handlers/pom.xml            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/powertools-e2e-tests/handlers/parameters/pom.xml b/powertools-e2e-tests/handlers/parameters/pom.xml
index 0b8c5d118..60cf8d868 100644
--- a/powertools-e2e-tests/handlers/parameters/pom.xml
+++ b/powertools-e2e-tests/handlers/parameters/pom.xml
@@ -19,7 +19,7 @@
         
         
             software.amazon.lambda
-            powertools-parameters
+            powertools-parameters-appconfig
         
         
             com.amazonaws
diff --git a/powertools-e2e-tests/handlers/pom.xml b/powertools-e2e-tests/handlers/pom.xml
index f27634feb..9476d24b6 100644
--- a/powertools-e2e-tests/handlers/pom.xml
+++ b/powertools-e2e-tests/handlers/pom.xml
@@ -71,7 +71,7 @@
             
             
                 software.amazon.lambda
-                powertools-parameters
+                powertools-parameters-appconfig
                 ${lambda.powertools.version}
             
             

From 487bd77bf5efa75af271c0611903f0af55d3e11c Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Fri, 8 Dec 2023 16:03:01 +0100
Subject: [PATCH 42/45] Clean up E2E test tree

---
 pom.xml                                       | 29 -------------------
 powertools-e2e-tests/handlers/batch/pom.xml   |  2 +-
 .../handlers/idempotency/pom.xml              |  2 +-
 .../handlers/largemessage/pom.xml             |  2 +-
 .../handlers/largemessage_idempotent/pom.xml  |  2 +-
 powertools-e2e-tests/handlers/logging/pom.xml |  2 +-
 powertools-e2e-tests/handlers/metrics/pom.xml |  4 +--
 .../handlers/parameters/pom.xml               |  4 +--
 .../lambda/powertools/e2e/Function.java       |  3 +-
 powertools-e2e-tests/handlers/pom.xml         |  8 +++--
 powertools-e2e-tests/handlers/tracing/pom.xml |  2 +-
 .../handlers/validation-alb-event/pom.xml     |  2 +-
 .../handlers/validation-apigw-event/pom.xml   |  2 +-
 13 files changed, 19 insertions(+), 45 deletions(-)

diff --git a/pom.xml b/pom.xml
index 3c2768b98..1d35a990f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -605,35 +605,6 @@
             
             
                 
-                    
-                        
-                        org.apache.maven.plugins
-                        maven-checkstyle-plugin
-                        3.3.0
-                        
-                            checkstyle.xml
-                            UTF-8
-                            true
-                            true
-                            false
-                        
-                        
-                        
-                        
-                            
-                                com.puppycrawl.tools
-                                checkstyle
-                                10.12.3
-                            
-                        
-                        
-                            
-                                
-                                    check
-                                
-                            
-                        
-                    
                 
             
         
diff --git a/powertools-e2e-tests/handlers/batch/pom.xml b/powertools-e2e-tests/handlers/batch/pom.xml
index ccb9926f1..8740dcb0b 100644
--- a/powertools-e2e-tests/handlers/batch/pom.xml
+++ b/powertools-e2e-tests/handlers/batch/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-batch
diff --git a/powertools-e2e-tests/handlers/idempotency/pom.xml b/powertools-e2e-tests/handlers/idempotency/pom.xml
index f033fce24..a0e6bd4fc 100644
--- a/powertools-e2e-tests/handlers/idempotency/pom.xml
+++ b/powertools-e2e-tests/handlers/idempotency/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-idempotency
diff --git a/powertools-e2e-tests/handlers/largemessage/pom.xml b/powertools-e2e-tests/handlers/largemessage/pom.xml
index e6539f4fe..277e76fc1 100644
--- a/powertools-e2e-tests/handlers/largemessage/pom.xml
+++ b/powertools-e2e-tests/handlers/largemessage/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-largemessage
diff --git a/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml b/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
index 5e7f026bf..d887341c5 100644
--- a/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
+++ b/powertools-e2e-tests/handlers/largemessage_idempotent/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-large-msg-idempotent
diff --git a/powertools-e2e-tests/handlers/logging/pom.xml b/powertools-e2e-tests/handlers/logging/pom.xml
index 86c149f45..222c5ab2e 100644
--- a/powertools-e2e-tests/handlers/logging/pom.xml
+++ b/powertools-e2e-tests/handlers/logging/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-logging
diff --git a/powertools-e2e-tests/handlers/metrics/pom.xml b/powertools-e2e-tests/handlers/metrics/pom.xml
index ce5e934d8..68059e67e 100644
--- a/powertools-e2e-tests/handlers/metrics/pom.xml
+++ b/powertools-e2e-tests/handlers/metrics/pom.xml
@@ -5,12 +5,12 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-metrics
     jar
-    A Lambda function using Powertools for AWS Lambda (Java) Parameters
+    A Lambda function using Powertools for AWS Lambda (Java) Metrics
 
     
         
diff --git a/powertools-e2e-tests/handlers/parameters/pom.xml b/powertools-e2e-tests/handlers/parameters/pom.xml
index 60cf8d868..328d30485 100644
--- a/powertools-e2e-tests/handlers/parameters/pom.xml
+++ b/powertools-e2e-tests/handlers/parameters/pom.xml
@@ -5,12 +5,12 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-parameters
     jar
-    A Lambda function using powertools logging
+    A Lambda function using powertools parameters
 
     
         
diff --git a/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java b/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
index 016844117..1e151825e 100644
--- a/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
+++ b/powertools-e2e-tests/handlers/parameters/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
@@ -17,8 +17,7 @@
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import software.amazon.lambda.powertools.logging.Logging;
-import software.amazon.lambda.powertools.parameters.AppConfigProvider;
-import software.amazon.lambda.powertools.parameters.ParamManager;
+import software.amazon.lambda.powertools.parameters.appconfig.AppConfigProvider;
 
 public class Function implements RequestHandler {
 
diff --git a/powertools-e2e-tests/handlers/pom.xml b/powertools-e2e-tests/handlers/pom.xml
index 9476d24b6..2c73de977 100644
--- a/powertools-e2e-tests/handlers/pom.xml
+++ b/powertools-e2e-tests/handlers/pom.xml
@@ -4,7 +4,7 @@
 
     software.amazon.lambda
     e2e-test-handlers-parent
-    2.0.0
+    2.0.0-SNAPSHOT
     pom
     Handlers for End-to-End tests
     Fake handlers that use Powertools for AWS Lambda (Java).
@@ -27,12 +27,16 @@
     
 
     
+        batch
+        largemessage
+        largemessage_idempotent
         logging
         tracing
         metrics
         idempotency
         parameters
-        validation
+        validation-alb-event
+        validation-apigw-event
     
 
     
diff --git a/powertools-e2e-tests/handlers/tracing/pom.xml b/powertools-e2e-tests/handlers/tracing/pom.xml
index b1bc14c05..b96fcef0a 100644
--- a/powertools-e2e-tests/handlers/tracing/pom.xml
+++ b/powertools-e2e-tests/handlers/tracing/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-tracing
diff --git a/powertools-e2e-tests/handlers/validation-alb-event/pom.xml b/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
index 36695b9a4..be50094c1 100644
--- a/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
+++ b/powertools-e2e-tests/handlers/validation-alb-event/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-validation-alb-event
diff --git a/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml b/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
index 8bb927778..f204a8a9f 100644
--- a/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
+++ b/powertools-e2e-tests/handlers/validation-apigw-event/pom.xml
@@ -5,7 +5,7 @@
     
         software.amazon.lambda
         e2e-test-handlers-parent
-        2.0.0
+        2.0.0-SNAPSHOT
     
 
     e2e-test-handler-validation-apigw-event

From d36f36dae3d9e6a8d6d1a5092579072a7928e567 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Mon, 11 Dec 2023 12:43:01 +0100
Subject: [PATCH 43/45] Apply suggestions from code review
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com>
---
 .../parameters/appconfig/AppConfigProviderTest.java        | 7 +++----
 .../powertools/parameters/dynamodb/DynamoDbParam.java      | 2 +-
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
index 7cbf7256b..bfa60618a 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
@@ -16,16 +16,15 @@
 
 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
 import static org.assertj.core.api.Assertions.assertThatRuntimeException;
-import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.MockitoAnnotations.openMocks;
 
-import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Captor;
 import org.mockito.Mock;
 import org.mockito.Mockito;
-import org.mockito.MockitoAnnotations;
 import software.amazon.awssdk.core.SdkBytes;
 import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient;
 import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationRequest;
@@ -53,7 +52,7 @@ public class AppConfigProviderTest {
 
     @BeforeEach
     public void init() {
-        MockitoAnnotations.openMocks(this);
+       openMocks(this);
 
         provider = AppConfigProvider.builder()
                 .withClient(client)
diff --git a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
index f1ba4fe8a..946786cb4 100644
--- a/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
+++ b/powertools-parameters/powertools-parameters-dynamodb/src/main/java/software/amazon/lambda/powertools/parameters/dynamodb/DynamoDbParam.java
@@ -26,7 +26,7 @@
  *
  * Usage:
  * 
- * @SSMParam(key = "my-param", table = "my-table")
+ * @DynamoDbParam(key = "my-param", table = "my-table")
  * String myParameter;
  * 

  */

From c7422f205a94c124988cd9346982a646fbe46d9b Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Mon, 11 Dec 2023 12:46:47 +0100
Subject: [PATCH 44/45] Apply suggestions from code review
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com>
---
 docs/utilities/parameters.md | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md
index 607791a82..f72c7704e 100644
--- a/docs/utilities/parameters.md
+++ b/docs/utilities/parameters.md
@@ -215,9 +215,8 @@ interface. In cases where a provider supports extra features, these will also be
         String secretParam;
 
         public string handleRequest(String request, Context context) {
-            // Because this is a secret, we probably don't want to return it! Return something indicating
-            // we could access it instead.
-            return "Retrieved a secret, and sensibly refusing to return it!";
+            // ... do something with the secretParam here
+            return "something";
         }
     }
     ```
@@ -245,9 +244,8 @@ interface. In cases where a provider supports extra features, these will also be
             // Retrieve a single secret
             String value = secretsProvider.get("/my/secret");
     
-            // Because this is a secret, we probably don't want to return it! Return something indicating
-            // we could access it instead.
-            return "Retrieved a secret, and sensibly refusing to return it!";
+            // ... do something with the secretParam here
+            return "something";
         }
     }
     ```
@@ -301,10 +299,10 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
                 .build();
     
         public String handleRequest(String input, Context context) {
-            // Retrieve a single secret
+            // Retrieve a single param
             String value = ssmProvider
                     .get("/my/secret");
-                    // We might instead want to retrieve multiple secrets at once, returning a Map of key/value pairs
+                    // We might instead want to retrieve multiple parameters at once, returning a Map of key/value pairs
                     // .getMultiple("/my/secret/path");
 
             // Return the result
@@ -365,7 +363,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
 
     public class RequestHandlerWithParams implements RequestHandler {
     
-        // Get an instance of the SecretsProvider. We can provide a custom client here if we want,
+        // Get an instance of the DynamoDbProvider. We can provide a custom client here if we want,
         // for instance to use a particular region.
         DynamoDbProvider ddbProvider = DynamoDbProvider
                 .builder()
@@ -373,7 +371,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
                 .build();
     
         public String handleRequest(String input, Context context) {
-            // Retrieve a single secret
+            // Retrieve a single param
             String value = ddbProvider
                     .get("/my/secret");
                     // We might instead want to retrieve multiple values at once, returning a Map of key/value pairs
@@ -418,7 +416,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
 
     public class RequestHandlerWithParams implements RequestHandler {
     
-        // Get an instance of the SecretsProvider. We can provide a custom client here if we want,
+        // Get an instance of the AppConfigProvider. We can provide a custom client here if we want,
         // for instance to use a particular region.
         AppConfigProvider appConfigProvider = AppConfigProvider
                 .builder()
@@ -426,7 +424,7 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
                 .build();
     
         public String handleRequest(String input, Context context) {
-            // Retrieve a single secret
+            // Retrieve a single param
             String value = appConfigProvider
                     .get("/my/secret");
     

From 75abe1e3e00f7fe9b0744a8c82fb9c79a60d7999 Mon Sep 17 00:00:00 2001
From: Scott Gerring 
Date: Mon, 11 Dec 2023 13:10:05 +0100
Subject: [PATCH 45/45] Update
 powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com>
---
 .../powertools/parameters/appconfig/AppConfigProviderTest.java  | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
index bfa60618a..ded568e8d 100644
--- a/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
+++ b/powertools-parameters/powertools-parameters-appconfig/src/test/java/software/amazon/lambda/powertools/parameters/appconfig/AppConfigProviderTest.java
@@ -52,7 +52,7 @@ public class AppConfigProviderTest {
 
     @BeforeEach
     public void init() {
-       openMocks(this);
+        openMocks(this);
 
         provider = AppConfigProvider.builder()
                 .withClient(client)