mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-09-19 06:32:00 +00:00
Code Issues Releases Wiki Activity

Make logging work correctly on Jetty (#2442)

Browse Source
This commit is contained in:
Lai Jiang
2024-05-14 14:36:26 +00:00
committed by GitHub
parent 6a5d8ed3b5
commit 6ca3cc230f
24 changed files with 1005 additions and 1127 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jetty/src/test/java/google/registry/jetty/LoggingPropertiesTest.java
-83
View File
@@ -1,83 +0,0 @@
// Copyright 2024 The Nomulus Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// 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 google.registry.jetty;
import static com.google.cloud.logging.TraceLoggingEnhancer.setCurrentTraceId;
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.base.Splitter;
import com.google.common.flogger.FluentLogger;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.Map;
import java.util.Optional;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
* Unit tests for verifying the `logging.properties` used by the Nomulus image.
*
* <p>The path to the property file is set as a system property by the Gradle test task. See the
* `jetty/build.gradle` script for more information.
*/
class LoggingPropertiesTest {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private PrintStream origStdout;
private ByteArrayOutputStream stdout;
/**
* Note that this test classes uses `System.out` and may cause conflicts in the following
* scenarios:
*
* <ul>
* <li>Another test class is added that also manipulates `System.out`
* <li>More test methods are added to this class and intra-class parallelization is enabled for
* this project.
* </ul>
*/
@BeforeEach
void setup() {
origStdout = System.out;
stdout = new ByteArrayOutputStream();
System.setOut(new PrintStream(stdout));
setCurrentTraceId("my custom trace id");
}
@AfterEach
void teardown() {
System.setOut(origStdout);
setCurrentTraceId(null);
}
@Test
void success_messageLogged_withTraceId() {
logger.atInfo().log("My log message.");
String logs = stdout.toString(UTF_8);
Optional<String> log =
Splitter.on('\n')
.splitToStream(logs)
.filter(line -> line.contains("My log message."))
.findAny();
assertThat(log).isPresent();
Map<String, ?> logRecord = new Gson().fromJson(log.get(), new TypeToken<>() {});
assertThat(logRecord).containsEntry("logging.googleapis.com/trace", "my custom trace id");
}
}