PLUGINAPI-36 Document default log level with LogTester

Author: henryju

CHANGELOG.md

@@ -11,4 +11,5 @@
   * Replace ~~`org.sonar.api.utils.log.Logger`~~ by `org.slf4j.Logger`
 * Utility classes used to test logs have been moved to a separate artifact `org.sonarsource.api.plugin:sonar-plugin-api-test-fixtures` and moved to a new package:
   *  `org.sonar.api.utils.log.LogTester` → `org.sonar.api.testfixtures.log.LogTester`
-  *  `org.sonar.api.utils.log.LogTesterJUnit5` → `org.sonar.api.testfixtures.log.LogTesterJUnit5`
+  *  `org.sonar.api.utils.log.LogTesterJUnit5` → `org.sonar.api.testfixtures.log.LogTesterJUnit5`
+* **Breaking change for tests**: the default log level when using `LogTester` is now `INFO`. This is consistent with the default behavior of Sonar products. If you want to assert `DEBUG` or `TRACE` logs in your tests, you should first change the log level by using for example `logTester.setLevel(Level.DEBUG)`.

test-fixtures/src/main/java/org/sonar/api/testfixtures/log/LogTester.java

@@ -24,10 +24,8 @@
 import org.junit.runners.model.Statement;
 
 /**
- * <b>For tests only</b>
- * <br>
- * This JUnit rule allows to configure and access logs in tests. By default
- * trace level is enabled.
+ * This JUnit rule allows to configure and access logs in tests. By default,
+ * INFO level is enabled.
  * <br>
  * Warning - not compatible with parallel execution of tests in the same JVM fork.
  * <br>

test-fixtures/src/main/java/org/sonar/api/testfixtures/log/LogTesterJUnit5.java

@@ -24,10 +24,8 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 
 /**
- * <b>For tests only</b>
- * <br>
- * This JUnit 5 extension allows to configure and access logs in tests. By default
- * trace level is enabled.
+ * This JUnit 5 extension allows to configure and access logs in tests. By default,
+ * INFO level is enabled.
  * <br>
  * Warning - not compatible with parallel execution of tests in the same JVM fork.
  * <br>