Cosmetic fixes/formatting. Re-order imports in changed test files, fix/improve typos/language in documentation.

Author: phipag

docs/FAQs.md

@@ -148,16 +148,16 @@ but due to the impact on the developer experience it was decided to stick with t
 
 Powertools core utilities, i.e. [logging](./core/logging.md), [metrics](./core/metrics.md) and [tracing](./core/tracing.md), include the [GraalVM Reachability Metadata (GRM)](https://www.graalvm.org/latest/reference-manual/native-image/metadata/) in the `META-INF` directories of the respective JARs. You can find a working example of Serverless Application Model (SAM) based application in the [examples](../examples/powertools-examples-core-utilities/sam-graalvm/README.md) directory.
 
-These are typical steps you need to follow in a maven based Java project
+Below, you find typical steps you need to follow in a Maven based Java project:
 
 ### Set the environment to use GraalVM
 
 ```shell
 export JAVA_HOME=<path to GraalVM>
 ```
 
-### Use log4j > 2.24.0
-Log4j version `2.24.0` adds [support for GraalVM](https://github.com/apache/logging-log4j2/issues/1539#issuecomment-2106766878). Depending on your project's dependency hierarchy, older version of log4j might be included in the final dependency graph. Make sure version `>2.24.0` of these dependencies are used by your maven project:
+### Use log4j `>2.24.0`
+Log4j version `2.24.0` adds [support for GraalVM](https://github.com/apache/logging-log4j2/issues/1539#issuecomment-2106766878). Depending on your project's dependency hierarchy, older version of log4j might be included in the final dependency graph. Make sure version `>2.24.0` of these dependencies are used by your Maven project:
 
 ```xml
 <dependencies>
@@ -187,7 +187,7 @@ Log4j version `2.24.0` adds [support for GraalVM](https://github.com/apache/logg
 
 ### Add the AWS Lambda Java Runtime Interface Client dependency
 
-Runtime Interface Client allow your function to receive invocation events from Lambda, send the response back to Lambda, and report errors to the Lambda service. Add the below dependency to your maven project:
+The Runtime Interface Client allows your function to receive invocation events from Lambda, send the response back to Lambda, and report errors to the Lambda service. Add the below dependency to your Maven project:
 
 ```xml
 <dependency>
@@ -197,11 +197,11 @@ Runtime Interface Client allow your function to receive invocation events from L
 </dependency>
 ```
 
-Also include the AWS Lambda GRM files by copying the `com.amazonaws`[directory](../examples/powertools-examples-core-utilities/sam-graalvm/src/main/resources/META-INF/native-image/) in your project's `META-INF/native-image` directory
+Also include the AWS Lambda GRM files by copying the `com.amazonaws` [directory](../examples/powertools-examples-core-utilities/sam-graalvm/src/main/resources/META-INF/native-image/) in your project's `META-INF/native-image` directory
 
 ### Build the native image
 
-1. Use the `native-maven-plugin` to build the native image. You can do this by adding the plugin to your `pom.xml` and creating a build profile called `native-image` that can build the native image of your Lambda function:
+Use the `native-maven-plugin` to build the native image. You can do this by adding the plugin to your `pom.xml` and creating a build profile called `native-image` that can build the native image of your Lambda function:
 
 ```xml
 <profiles>
@@ -239,16 +239,16 @@ Also include the AWS Lambda GRM files by copying the `com.amazonaws`[directory](
 </profiles>
 ```
 
-2. Create a docker image using a Dockerfile like [this](../examples/powertools-examples-core-utilities/sam-graalvm/Dockerfile) to create an x86 based build image.
+Create a Docker image using a `Dockerfile` like [this](../examples/powertools-examples-core-utilities/sam-graalvm/Dockerfile) to create an x86 based build image.
 
 ```shell
 docker build --platform linux/amd64 . -t your-org/your-app-graalvm-builder
 ```
 
-3. Create the native image of you Lambda function using the docker command below. 
+Create the native image of you Lambda function using the Docker command below. 
 
 ```shell
 docker run --platform linux/amd64 -it -v `pwd`:`pwd` -w `pwd` -v ~/.m2:/root/.m2 your-org/your-app-graalvm-builder mvn clean -Pnative-image package
 
 ```
-The native image is created in the target directory.
+The native image is created in the `target/` directory.

docs/core/logging.md

@@ -444,7 +444,7 @@ we provide [built-in JMESPath expressions](#built-in-correlation-id-expressions)
 
 #### Custom keys
 
-** Using StructuredArguments **
+**Using StructuredArguments**
 
 To append additional keys in your logs, you can use the `StructuredArguments` class:
 
@@ -624,7 +624,7 @@ To append additional keys in your logs, you can use the `StructuredArguments` cl
             }
         ```
 
-** Using MDC **
+**Using MDC**
 
 Mapped Diagnostic Context (MDC) is essentially a Key-Value store. It is supported by the [SLF4J API](https://www.slf4j.org/manual.html#mdc){target="_blank"},
 [logback](https://logback.qos.ch/manual/mdc.html){target="_blank"} and log4j (known as [ThreadContext](https://logging.apache.org/log4j/2.x/manual/thread-context.html){target="_blank"}). You can use the following standard:
@@ -1048,4 +1048,4 @@ Use the `LambdaEcsEncoder` rather than the `LambdaJsonEncoder` when configuring
             <appender-ref ref="console" />
         </root>
     </configuration>
-    ```
+    ```

examples/powertools-examples-core-utilities/sam-graalvm/README.md

@@ -1,56 +1,64 @@
-#  Powertools for AWS Lambda (Java) - Core Utilities Example with SAM on GraalVM
+# Powertools for AWS Lambda (Java) - Core Utilities Example with SAM on GraalVM
 
 This project demonstrates the Lambda for Powertools Java module deployed using [Serverless Application Model](https://aws.amazon.com/serverless/sam/) running as a GraalVM native image.
 
 For general information on the deployed example itself, you can refer to the parent [README](../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.
 
- - Set the environment to use GraalVM
+- 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.
 
-```shell 
+- Set the environment to use GraalVM
+
+```shell
 export JAVA_HOME=<path to GraalVM>
 ```
 
 ## Build the sample application
 
 - Build the Docker image that will be used as the environment for SAM build:
+
 ```shell
 docker build --platform linux/amd64 . -t powertools-examples-core-sam-graalvm
 ```
 
 - Build the SAM project using the docker image
+
 ```shell
 sam build --use-container --build-image powertools-examples-core-sam-graalvm
-
 ```
+
 #### [Optional] Building with -SNAPSHOT versions of PowerTools
+
 - If you are testing the example with a -SNAPSHOT version of PowerTools, the maven build inside the docker image will fail. This is because the -SNAPSHOT version of the PowerTools library that you are working on is still not available in maven central/snapshot repository.
-To get around this, follow these steps: 
-  - Create the native image using the `docker` command below on your development machine. The native image is created in the `target` directory. 
-    - ```docker run --platform linux/amd64  -it -v `pwd`:`pwd` -w `pwd` -v ~/.m2:/root/.m2 powertools-examples-core-sam-graalvm mvn clean -Pnative-image package -DskipTests```
+  To get around this, follow these steps:
+  - Create the native image using the `docker` command below on your development machine. The native image is created in the `target` directory.
+    - `` docker run --platform linux/amd64  -it -v `pwd`:`pwd` -w `pwd` -v ~/.m2:/root/.m2 powertools-examples-core-sam-graalvm mvn clean -Pnative-image package -DskipTests ``
   - Edit the [`Makefile`](Makefile) remove this line
-    - ```mvn clean package -P native-image```
+    - `mvn clean package -P native-image`
   - Build the SAM project using the docker image
-    - ```sam build --use-container --build-image powertools-examples-core-sam-graalvm```
+    - `sam build --use-container --build-image powertools-examples-core-sam-graalvm`
 
 ## Deploy the sample application
+
 - SAM deploy
 
-       sam deploy
+```shell
+sam deploy
+```
 
 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
-```
+```

powertools-common/src/test/java/software/amazon/lambda/powertools/common/internal/LambdaHandlerProcessorTest.java

@@ -19,18 +19,20 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
-import com.amazonaws.services.lambda.runtime.Context;
-import com.amazonaws.services.lambda.runtime.RequestHandler;
-import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.Optional;
+
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.Signature;
 import org.junit.jupiter.api.Test;
 import org.junitpioneer.jupiter.ClearEnvironmentVariable;
 import org.junitpioneer.jupiter.SetEnvironmentVariable;
 
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestHandler;
+import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
+
 class LambdaHandlerProcessorTest {
 
     private Signature signature = mock(Signature.class);
@@ -234,4 +236,4 @@ private ProceedingJoinPoint mockRequestHandlerPjp(Class handlerClass, Object[] h
         when(pjpMock.getSignature()).thenReturn(signature);
         return pjpMock;
     }
-}
+}

powertools-logging/src/test/java/software/amazon/lambda/powertools/logging/internal/LambdaLoggingAspectTest.java

@@ -29,15 +29,6 @@
 import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.FUNCTION_VERSION;
 import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.SERVICE;
 
-import com.amazonaws.services.lambda.runtime.Context;
-import com.amazonaws.services.lambda.runtime.RequestHandler;
-import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
-import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
-import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPEvent;
-import com.amazonaws.services.lambda.runtime.events.ApplicationLoadBalancerRequestEvent;
-import com.amazonaws.services.lambda.runtime.events.SQSEvent;
-import com.amazonaws.services.lambda.runtime.tests.annotations.Event;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -55,6 +46,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -68,6 +60,17 @@
 import org.slf4j.MDC;
 import org.slf4j.event.Level;
 import org.slf4j.test.TestLogger;
+
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestHandler;
+import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
+import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
+import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPEvent;
+import com.amazonaws.services.lambda.runtime.events.ApplicationLoadBalancerRequestEvent;
+import com.amazonaws.services.lambda.runtime.events.SQSEvent;
+import com.amazonaws.services.lambda.runtime.tests.annotations.Event;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.logging.argument.KeyValueArgument;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogAlbCorrelationId;
@@ -780,4 +783,4 @@ private void resetLogLevel(Level level)
         setLogLevels.invoke(null, level);
         writeStaticField(LambdaLoggingAspect.class, "LEVEL_AT_INITIALISATION", level, true);
     }
-}
+}

powertools-metrics/pom.xml

@@ -204,4 +204,4 @@
             </plugin>
         </plugins>
     </build>
-</project>
+</project>

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerTest.java

@@ -17,18 +17,21 @@
 import static java.util.Collections.emptyMap;
 import static org.assertj.core.api.Assertions.assertThat;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.function.Consumer;
+
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junitpioneer.jupiter.SetEnvironmentVariable;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
 import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
@@ -226,4 +229,4 @@ private Map<String, Object> readAsJson(String s) {
         }
         return emptyMap();
     }
-}
+}

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/LambdaMetricsAspectTest.java

@@ -21,22 +21,24 @@
 import static org.mockito.Mockito.when;
 import static org.mockito.MockitoAnnotations.openMocks;
 
-import com.amazonaws.services.lambda.runtime.Context;
-import com.amazonaws.services.lambda.runtime.RequestHandler;
-import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
 import java.util.Map;
+
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junitpioneer.jupiter.SetEnvironmentVariable;
 import org.mockito.Mock;
 
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestHandler;
+import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.metrics.MetricsUtils;

powertools-tracing/src/test/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspectTest.java

@@ -21,18 +21,21 @@
 import static org.mockito.Mockito.when;
 import static org.mockito.MockitoAnnotations.openMocks;
 
-import com.amazonaws.services.lambda.runtime.Context;
-import com.amazonaws.services.lambda.runtime.RequestHandler;
-import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
-import com.amazonaws.xray.AWSXRay;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junitpioneer.jupiter.SetEnvironmentVariable;
 import org.mockito.Mock;
+
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestHandler;
+import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
+import com.amazonaws.xray.AWSXRay;
+
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.tracing.handlers.PowerToolDisabled;
 import software.amazon.lambda.powertools.tracing.handlers.PowerToolDisabledForStream;