[android] - add setVerbosity to Logger, add LogLevel IntDef

This commit is contained in:
tobrun
2019-06-25 11:21:53 +02:00
committed by Tobrun
parent 8fbe63b51b
commit c5b04677f0
2 changed files with 200 additions and 10 deletions

View File

@@ -1,8 +1,13 @@
package com.mapbox.mapboxsdk.log;
import android.support.annotation.IntDef;
import android.support.annotation.Keep;
import android.util.Log;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Logger for the Mapbox Maps SDK for Android
* <p>
@@ -68,6 +73,22 @@ public final class Logger {
private static volatile LoggerDefinition logger = DEFAULT;
@LogLevel
private static int logLevel;
/**
* Set the verbosity of the Logger.
* <p>
* This configuration can be used to have more granular control over which logs are emitted by the
* Mapbox Maps SDK for Android.
* </p>
*
* @param logLevel the verbosity level
*/
public static void setVerbosity(@LogLevel int logLevel) {
Logger.logLevel = logLevel;
}
/**
* Replace the current used logger definition.
*
@@ -85,7 +106,9 @@ public final class Logger {
* @param msg The message you would like logged.
*/
public static void v(String tag, String msg) {
logger.v(tag, msg);
if (logLevel <= VERBOSE) {
logger.v(tag, msg);
}
}
/**
@@ -97,7 +120,9 @@ public final class Logger {
* @param tr An exception to log
*/
public static void v(String tag, String msg, Throwable tr) {
logger.v(tag, msg, tr);
if (logLevel <= VERBOSE) {
logger.v(tag, msg, tr);
}
}
/**
@@ -108,7 +133,9 @@ public final class Logger {
* @param msg The message you would like logged.
*/
public static void d(String tag, String msg) {
logger.d(tag, msg);
if (logLevel <= DEBUG) {
logger.d(tag, msg);
}
}
/**
@@ -120,7 +147,9 @@ public final class Logger {
* @param tr An exception to log
*/
public static void d(String tag, String msg, Throwable tr) {
logger.d(tag, msg, tr);
if (logLevel <= DEBUG) {
logger.d(tag, msg, tr);
}
}
/**
@@ -131,7 +160,9 @@ public final class Logger {
* @param msg The message you would like logged.
*/
public static void i(String tag, String msg) {
logger.i(tag, msg);
if (logLevel <= INFO) {
logger.i(tag, msg);
}
}
/**
@@ -143,7 +174,9 @@ public final class Logger {
* @param tr An exception to log
*/
public static void i(String tag, String msg, Throwable tr) {
logger.i(tag, msg, tr);
if (logLevel <= INFO) {
logger.i(tag, msg, tr);
}
}
/**
@@ -154,7 +187,9 @@ public final class Logger {
* @param msg The message you would like logged.
*/
public static void w(String tag, String msg) {
logger.w(tag, msg);
if (logLevel <= WARN) {
logger.w(tag, msg);
}
}
/**
@@ -166,7 +201,9 @@ public final class Logger {
* @param tr An exception to log
*/
public static void w(String tag, String msg, Throwable tr) {
logger.w(tag, msg, tr);
if (logLevel <= WARN) {
logger.w(tag, msg, tr);
}
}
/**
@@ -177,7 +214,9 @@ public final class Logger {
* @param msg The message you would like logged.
*/
public static void e(String tag, String msg) {
logger.e(tag, msg);
if (logLevel <= ERROR) {
logger.e(tag, msg);
}
}
/**
@@ -189,7 +228,9 @@ public final class Logger {
* @param tr An exception to log
*/
public static void e(String tag, String msg, Throwable tr) {
logger.e(tag, msg, tr);
if (logLevel <= ERROR) {
logger.e(tag, msg, tr);
}
}
/**
@@ -221,4 +262,60 @@ public final class Logger {
throw new UnsupportedOperationException();
}
}
/**
* Priority constant for the println method; use Logger.v
* <p>
* This log level will print all logs.
* </p>
*/
public static final int VERBOSE = Log.VERBOSE;
/**
* Priority constant for the println method; use Logger.d.
* <p>
* This log level will print all logs except verbose.
* </p>
*/
public static final int DEBUG = Log.DEBUG;
/**
* Priority constant for the println method; use Logger.i.
* <p>
* This log level will print all logs except verbose and debug.
* </p>
*/
public static final int INFO = Log.INFO;
/**
* Priority constant for the println method; use Logger.w.
* <p>
* This log level will print only warn and error logs.
* </p>
*/
public static final int WARN = Log.WARN;
/**
* Priority constant for the println method; use Logger.e.
* <p>
* This log level will print only error logs.
* </p>
*/
public static final int ERROR = Log.ERROR;
/**
* Priority constant for the println method.
* <p>
* This log level won't print any logs.
* </p>
*/
public static final int NONE = 99;
/**
* Log level indicates which logs are allowed to be emitted by the Mapbox Maps SDK for Android.
*/
@IntDef( {VERBOSE, DEBUG, INFO, WARN, ERROR, NONE})
@Retention(RetentionPolicy.SOURCE)
public @interface LogLevel {
}
}

View File

@@ -0,0 +1,93 @@
package com.mapbox.mapboxsdk.log
import io.mockk.mockk
import io.mockk.verify
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.robolectric.RobolectricTestRunner
@RunWith(RobolectricTestRunner::class)
class LoggerTest {
private val logger: LoggerDefinition = mockk(relaxed = true)
@Before
fun setUp() {
Logger.setLoggerDefinition(logger)
}
@Test
fun verbosityLogLevel() {
Logger.setVerbosity(Logger.VERBOSE)
Logger.v(TAG, MESSAGE)
verify { logger.v(TAG, MESSAGE) }
}
@Test
fun verbosityLogLevelIgnore() {
Logger.setVerbosity(Logger.DEBUG)
Logger.v(TAG, MESSAGE)
verify(exactly = 0){ logger.v(TAG, MESSAGE) }
}
@Test
fun debugLogLevel() {
Logger.setVerbosity(Logger.VERBOSE)
Logger.d(TAG, MESSAGE)
verify { logger.d(TAG, MESSAGE) }
}
@Test
fun debugLogLevelIgnore() {
Logger.setVerbosity(Logger.WARN)
Logger.d(TAG, MESSAGE)
verify(exactly = 0){ logger.d(TAG, MESSAGE) }
}
@Test
fun warnLogLevel() {
Logger.setVerbosity(Logger.WARN)
Logger.w(TAG, MESSAGE)
verify { logger.w(TAG, MESSAGE) }
}
@Test
fun warnLogLevelIgnore() {
Logger.setVerbosity(Logger.ERROR)
Logger.w(TAG, MESSAGE)
verify(exactly = 0){ logger.w(TAG, MESSAGE) }
}
@Test
fun errorLogLevel() {
Logger.setVerbosity(Logger.ERROR)
Logger.e(TAG, MESSAGE)
verify { logger.e(TAG, MESSAGE) }
}
@Test
fun errorLogLevelIgnore() {
Logger.setVerbosity(Logger.NONE)
Logger.e(TAG, MESSAGE)
verify(exactly = 0){ logger.e(TAG, MESSAGE) }
}
@Test
fun noneLogLevelIgnore() {
Logger.setVerbosity(Logger.NONE)
Logger.v(TAG, MESSAGE)
Logger.d(TAG, MESSAGE)
Logger.w(TAG, MESSAGE)
Logger.e(TAG, MESSAGE)
verify(exactly = 0){ logger.v(TAG, MESSAGE) }
verify(exactly = 0){ logger.d(TAG, MESSAGE) }
verify(exactly = 0){ logger.w(TAG, MESSAGE) }
verify(exactly = 0){ logger.e(TAG, MESSAGE) }
}
companion object {
const val TAG: String = "TAG"
const val MESSAGE: String = "message"
}
}