Skip to content

Commit 9895e81

Browse files
Add JUnit LoggerExtension documentation
1 parent 9ad7782 commit 9895e81

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

extractor/src/test/java/org/schabi/newpipe/extractor/LoggerExtension.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
import org.junit.jupiter.api.extension.ExtensionContext;
55
import org.schabi.newpipe.extractor.utils.ExtractorLogger;
66

7+
/**
8+
* JUnit extension class for globally setting up the logger for all extractor tests<br>
9+
* See <a href="https://www.baeldung.com/junit-5-extensions#1-automatic-extension-registration">here</a> on how this works
10+
* <br>
11+
* To disable this, set {@code junit.jupiter.extensions.autodetection.enabled = false}
12+
* in junit-platform.properties
13+
*/
714
public class LoggerExtension implements BeforeAllCallback {
815
private static boolean set = false;
916

extractor/src/test/java/org/schabi/newpipe/extractor/utils/ExtractorLoggerTest.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
import static org.junit.jupiter.api.Assertions.*;
77

8+
/**
9+
* See {@link org.schabi.newpipe.extractor.LoggerExtension} for how global logging is set up for tests
10+
*/
811
class ExtractorLoggerTest {
912

1013
private CapturingLogger logger;

0 commit comments

Comments
 (0)