feat(v2): new logging module #1435
complete tests for log4j implementation
- Loading branch information
commit 36cc83d082d490c60e67354569aa4eae480adae5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * 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 org.apache.logging.log4j.layout.template.json.resolver; | ||
|
|
||
| import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.contentOf; | ||
| import static org.mockito.Mockito.when; | ||
| import static org.mockito.MockitoAnnotations.openMocks; | ||
|
|
||
| import com.amazonaws.services.lambda.runtime.Context; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.channels.FileChannel; | ||
| import java.nio.file.NoSuchFileException; | ||
| import java.nio.file.Paths; | ||
| import java.nio.file.StandardOpenOption; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junitpioneer.jupiter.SetEnvironmentVariable; | ||
| import org.mockito.Mock; | ||
| import org.slf4j.MDC; | ||
| import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor; | ||
| import software.amazon.lambda.powertools.logging.internal.handler.PowertoolsLogEnabled; | ||
|
|
||
| class PowerToolsResolverFactoryTest { | ||
|
|
||
| @Mock | ||
| private Context context; | ||
|
|
||
| @BeforeEach | ||
| void setUp() throws IllegalAccessException, IOException { | ||
| openMocks(this); | ||
| MDC.clear(); | ||
| writeStaticField(LambdaHandlerProcessor.class, "IS_COLD_START", null, true); | ||
| setupContext(); | ||
| // Make sure file is cleaned up before running tests | ||
| try { | ||
| FileChannel.open(Paths.get("target/logfile.json"), StandardOpenOption.WRITE).truncate(0).close(); | ||
| FileChannel.open(Paths.get("target/ecslogfile.json"), StandardOpenOption.WRITE).truncate(0).close(); | ||
| } catch (NoSuchFileException e) { | ||
| // file may not exist on the first launch | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| @SetEnvironmentVariable(key = "POWERTOOLS_SERVICE_NAME", value = "testLog4j") | ||
| @SetEnvironmentVariable(key = "POWERTOOLS_LOGGER_SAMPLE_RATE", value = "0.000000001") | ||
| @SetEnvironmentVariable(key = "_X_AMZN_TRACE_ID", value = "Root=1-63441c4a-abcdef012345678912345678") | ||
| void shouldLogInJsonFormat() { | ||
| PowertoolsLogEnabled handler = new PowertoolsLogEnabled(); | ||
| handler.handleRequest("Input", context); | ||
|
|
||
| File logFile = new File("target/logfile.json"); | ||
| assertThat(contentOf(logFile)).startsWith( | ||
| "{\"cold_start\":true,\"function_arn\":\"arn:aws:lambda:eu-west-1:012345678910:function:testFunction:1\",\"function_memory_size\":1024,\"function_name\":\"testFunction\",\"function_request_id\":\"RequestId\",\"function_version\":\"1\",\"level\":\"INFO\",\"message\":\"Test event\",\"sampling_rate\":1.0E-9,\"service\":\"testLog4j\",\"timestamp\":") | ||
| .endsWith("\"xray_trace_id\":\"1-63441c4a-abcdef012345678912345678\",\"myKey\":\"myValue\"}\n"); | ||
| } | ||
|
|
||
| @Test | ||
| @SetEnvironmentVariable(key = "AWS_REGION", value = "eu-central-1") | ||
| @SetEnvironmentVariable(key = "POWERTOOLS_SERVICE_NAME", value = "testLog4jEcs") | ||
| @SetEnvironmentVariable(key = "_X_AMZN_TRACE_ID", value = "Root=1-63441c4a-abcdef012345678912345678") | ||
| void shouldLogInEcsFormat() { | ||
| PowertoolsLogEnabled handler = new PowertoolsLogEnabled(); | ||
| handler.handleRequest("Input", context); | ||
|
|
||
| File logFile = new File("target/ecslogfile.json"); | ||
| assertThat(contentOf(logFile)).endsWith( | ||
| "\"ecs.version\":\"1.2.0\",\"log.level\":\"INFO\",\"message\":\"Test event\",\"service.name\":\"testLog4j\",\"service.version\":\"1\",\"process.thread.name\":\"main\",\"log.logger\":\"software.amazon.lambda.powertools.logging.internal.handler.PowertoolsLogEnabled\",\"cloud.provider\":\"aws\",\"cloud.service.name\":\"lambda\",\"cloud.region\":\"eu-central-1\",\"cloud.account.id\":\"012345678910\",\"faas.coldstart\":true,\"faas.id\":\"arn:aws:lambda:eu-west-1:012345678910:function:testFunction:1\",\"faas.memory\":1024,\"faas.name\":\"testFunction\",\"faas.execution\":\"RequestId\",\"faas.version\":\"1\",\"myKey\":\"myValue\",\"trace.id\":\"1-63441c4a-abcdef012345678912345678\"}\n") | ||
| .startsWith("{\"@timestamp\":\""); | ||
| } | ||
|
|
||
| private void setupContext() { | ||
| when(context.getFunctionName()).thenReturn("testFunction"); | ||
| when(context.getInvokedFunctionArn()).thenReturn( | ||
| "arn:aws:lambda:eu-west-1:012345678910:function:testFunction:1"); | ||
| when(context.getFunctionVersion()).thenReturn("1"); | ||
| when(context.getMemoryLimitInMB()).thenReturn(1024); | ||
| when(context.getAwsRequestId()).thenReturn("RequestId"); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * 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 org.apache.logging.log4j.layout.template.json.resolver; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.FUNCTION_ARN; | ||
| import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.FUNCTION_COLD_START; | ||
| import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.FUNCTION_MEMORY_SIZE; | ||
| import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.SAMPLING_RATE; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.apache.logging.log4j.core.impl.Log4jLogEvent; | ||
| import org.apache.logging.log4j.layout.template.json.util.JsonWriter; | ||
| import org.apache.logging.log4j.util.SortedArrayStringMap; | ||
| import org.apache.logging.log4j.util.StringMap; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.EnumSource; | ||
| import org.junitpioneer.jupiter.SetEnvironmentVariable; | ||
| import software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields; | ||
|
|
||
| class PowertoolsResolverTest { | ||
|
|
||
| @ParameterizedTest | ||
| @EnumSource(value = PowertoolsLoggedFields.class, | ||
| mode = EnumSource.Mode.EXCLUDE, | ||
| names = {"FUNCTION_MEMORY_SIZE", "SAMPLING_RATE", "FUNCTION_COLD_START"}) | ||
| void shouldResolveFunctionStringInfo(PowertoolsLoggedFields field) { | ||
| String result = resolveField(field.getName(), "value"); | ||
| assertThat(result).isEqualTo("\"value\""); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldResolveMemorySize() { | ||
| String result = resolveField(FUNCTION_MEMORY_SIZE.getName(), "42"); | ||
| assertThat(result).isEqualTo("42"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldResolveSamplingRate() { | ||
| String result = resolveField(SAMPLING_RATE.getName(), "0.4"); | ||
| assertThat(result).isEqualTo("0.4"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldResolveColdStart() { | ||
| String result = resolveField(FUNCTION_COLD_START.getName(), "true"); | ||
| assertThat(result).isEqualTo("true"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldResolveAccountId() { | ||
| String result = resolveField(FUNCTION_ARN.getName(), "account_id", "arn:aws:lambda:us-east-2:123456789012:function:my-function"); | ||
| assertThat(result).isEqualTo("\"123456789012\""); | ||
| } | ||
|
|
||
| @Test | ||
| @SetEnvironmentVariable(key = "AWS_REGION", value = "eu-central-2") | ||
| void shouldResolveRegion() { | ||
| String result = resolveField("region", "dummy, will use the env var"); | ||
| assertThat(result).isEqualTo("\"eu-central-2\""); | ||
| } | ||
|
|
||
| private static String resolveField(String field, String value) { | ||
| return resolveField(field, field, value); | ||
| } | ||
|
|
||
| private static String resolveField(String data, String field, String value) { | ||
| Map<String, Object> configMap = new HashMap<>(); | ||
| configMap.put("field", field); | ||
|
|
||
| TemplateResolverConfig config = new TemplateResolverConfig(configMap); | ||
| PowertoolsResolver resolver = new PowertoolsResolver(config); | ||
| JsonWriter writer = JsonWriter | ||
| .newBuilder() | ||
| .setMaxStringLength(1000) | ||
| .setTruncatedStringSuffix("") | ||
| .build(); | ||
|
|
||
| StringMap contextMap = new SortedArrayStringMap(); | ||
| contextMap.putValue(data, value); | ||
|
|
||
| Log4jLogEvent logEvent = Log4jLogEvent.newBuilder().setContextData(contextMap).build(); | ||
| if (resolver.isResolvable(logEvent)) { | ||
| resolver.resolve(logEvent, writer); | ||
| } | ||
|
|
||
| return writer.getStringBuilder().toString(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.