Set "debug" through external properties. (#1186)

maciejwalkowiak · web-flow · commit c3b9cf74d728 · 2021-01-20T10:44:21.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 * Enhancement: Add overload for `transaction/span.finish(SpanStatus)` (#1182)
 * Fix: Bring back support for setting transaction name without ongoing transaction (#1183)
 * Enhancement: Simplify registering traces sample callback in Spring integration (#1184)
+* Enhancement: Set "debug" through external properties (#1186)
 
 # 4.0.0-alpha.3
 
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt
@@ -163,7 +163,7 @@ class AndroidOptionsInitializerTest {
         val mockContext = ContextUtilsTest.mockMetaData(metaData = createBundleWithDsn())
         val logger = mock<ILogger>()
         val sentryOptions = SentryAndroidOptions().apply {
-            isDebug = true
+            setDebug(true)
         }
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext, logger, createBuildInfo(), createClassMock())
@@ -180,7 +180,7 @@ class AndroidOptionsInitializerTest {
         val mockContext = ContextUtilsTest.mockMetaData(metaData = createBundleWithDsn())
         val logger = mock<ILogger>()
         val sentryOptions = SentryAndroidOptions().apply {
-            isDebug = true
+            setDebug(true)
         }
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext, logger, createBuildInfo(14), createClassMock())
@@ -197,7 +197,7 @@ class AndroidOptionsInitializerTest {
         val mockContext = ContextUtilsTest.mockMetaData(metaData = createBundleWithDsn())
         val logger = mock<ILogger>()
         val sentryOptions = SentryAndroidOptions().apply {
-            isDebug = true
+            setDebug(true)
         }
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext, logger, createBuildInfo(), createClassMockThrows(UnsatisfiedLinkError()))
@@ -213,7 +213,7 @@ class AndroidOptionsInitializerTest {
         val mockContext = ContextUtilsTest.mockMetaData(metaData = createBundleWithDsn())
         val logger = mock<ILogger>()
         val sentryOptions = SentryAndroidOptions().apply {
-            isDebug = true
+            setDebug(true)
         }
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext, logger, createBuildInfo(), createClassMockThrows(ClassNotFoundException()))
@@ -229,7 +229,7 @@ class AndroidOptionsInitializerTest {
         val mockContext = ContextUtilsTest.mockMetaData(metaData = createBundleWithDsn())
         val logger = mock<ILogger>()
         val sentryOptions = SentryAndroidOptions().apply {
-            isDebug = true
+            setDebug(true)
         }
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext, logger, createBuildInfo(), createClassMockThrows(RuntimeException()))
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/DefaultAndroidEventProcessorTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/DefaultAndroidEventProcessorTest.kt
@@ -43,7 +43,7 @@ class DefaultAndroidEventProcessorTest {
     private class Fixture {
         val buildInfo = mock<IBuildInfoProvider>()
         val options = SentryOptions().apply {
-            isDebug = true
+            setDebug(true)
             setLogger(mock())
             sdkVersion = SdkVersion().apply {
                 name = "test"
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/EnvelopeFileObserverTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/EnvelopeFileObserverTest.kt
@@ -33,7 +33,7 @@ class EnvelopeFileObserverTest {
         val envelopeSender = mock<IEnvelopeSender>()
         val logger = mock<ILogger>()
         val options = SentryOptions().apply {
-            isDebug = true
+            setDebug(true)
             setLogger(logger)
         }
 
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt
@@ -36,7 +36,7 @@ class ManifestMetadataReaderTest {
 
     @Test
     fun `isAutoInit won't throw exception and is enabled by default`() {
-        fixture.options.isDebug = true
+        fixture.options.setDebug(true)
         val context = fixture.getContext()
 
         assertTrue(ManifestMetadataReader.isAutoInit(context, fixture.logger))
@@ -53,7 +53,7 @@ class ManifestMetadataReaderTest {
 
     @Test
     fun `applyMetadata won't throw exception`() {
-        fixture.options.isDebug = true
+        fixture.options.setDebug(true)
         val context = fixture.getContext()
 
         ManifestMetadataReader.applyMetadata(context, fixture.options)
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/NdkIntegrationTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/NdkIntegrationTest.kt
@@ -122,7 +122,7 @@ class NdkIntegrationTest {
     private fun getOptions(enableNdk: Boolean = true, logger: ILogger = mock(), cacheDir: String? = "abc"): SentryAndroidOptions {
         return SentryAndroidOptions().apply {
             setLogger(logger)
-            isDebug = true
+            setDebug(true)
             isEnableNdk = enableNdk
             cacheDirPath = cacheDir
         }
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -735,7 +735,7 @@ public class io/sentry/SentryOptions {
 	public fun setCacheDirPath (Ljava/lang/String;)V
 	public fun setCacheDirSize (I)V
 	public fun setConnectionTimeoutMillis (I)V
-	public fun setDebug (Z)V
+	public fun setDebug (Ljava/lang/Boolean;)V
 	public fun setDiagnosticLevel (Lio/sentry/SentryLevel;)V
 	public fun setDist (Ljava/lang/String;)V
 	public fun setDistinctId (Ljava/lang/String;)V
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -66,7 +66,7 @@ public class SentryOptions {
    * Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging
    * information if something goes wrong. Default is disabled.
    */
-  private boolean debug;
+  private @Nullable Boolean debug;
 
   /** Turns NDK on or off. Default is enabled. */
   private boolean enableNdk = true;
@@ -270,6 +270,7 @@ public class SentryOptions {
     options.setEnableUncaughtExceptionHandler(
         propertiesProvider.getBooleanProperty("uncaught.handler.enabled"));
     options.setTracesSampleRate(propertiesProvider.getDoubleProperty("traces-sample-rate"));
+    options.setDebug(propertiesProvider.getBooleanProperty("debug"));
     final Map<String, String> tags = propertiesProvider.getMap("tags");
     for (final Map.Entry<String, String> tag : tags.entrySet()) {
       options.setTag(tag.getKey(), tag.getValue());
@@ -353,18 +354,27 @@ public void setDsn(@Nullable String dsn) {
    * @return true if ON or false otherwise
    */
   public boolean isDebug() {
-    return debug;
+    return Boolean.TRUE.equals(debug);
   }
 
   /**
    * Sets the debug mode to ON or OFF Default is OFF
    *
    * @param debug true if ON or false otherwise
    */
-  public void setDebug(boolean debug) {
+  public void setDebug(final @Nullable Boolean debug) {
     this.debug = debug;
   }
 
+  /**
+   * Check if debug mode is ON, OFF or not set.
+   *
+   * @return true if ON or false otherwise
+   */
+  private @Nullable Boolean getDebug() {
+    return debug;
+  }
+
   /**
    * Returns the Logger interface
    *
@@ -1305,6 +1315,9 @@ void merge(final @NotNull SentryOptions options) {
     if (options.getTracesSampleRate() != null) {
       setTracesSampleRate(options.getTracesSampleRate());
     }
+    if (options.getDebug() != null) {
+      setDebug(options.getDebug());
+    }
     final Map<String, String> tags = new HashMap<>(options.getTags());
     for (final Map.Entry<String, String> tag : tags.entrySet()) {
       this.tags.put(tag.getKey(), tag.getValue());
diff --git a/sentry/src/test/java/io/sentry/DiagnosticLoggerTest.kt b/sentry/src/test/java/io/sentry/DiagnosticLoggerTest.kt
@@ -10,7 +10,7 @@ class DiagnosticLoggerTest {
 
     private class Fixture {
         val options = SentryOptions().apply {
-            isDebug = true
+            setDebug(true)
             setLogger(logger)
         }
         var logger: ILogger? = mock()
@@ -79,7 +79,7 @@ class DiagnosticLoggerTest {
 
     @Test
     fun `when debug is false and option level is fatal, a call to log and level error is not logged`() {
-        fixture.options.isDebug = false
+        fixture.options.setDebug(false)
         val sut = fixture.getSut()
         val expectedLevel = SentryLevel.FATAL
         sut.log(expectedLevel, expectedMessage)
@@ -106,7 +106,7 @@ class DiagnosticLoggerTest {
 
     @Test
     fun `when debug is false option level is debug, a call to log with throwable and level info is not logged`() {
-        fixture.options.isDebug = false
+        fixture.options.setDebug(false)
         fixture.options.setDiagnosticLevel(SentryLevel.DEBUG)
         val sut = fixture.getSut()
         val expectedLevel = SentryLevel.INFO
@@ -143,7 +143,7 @@ class DiagnosticLoggerTest {
 
     @Test
     fun `when debug is false option level is fatal, a call to log with throwable and level error is not logged`() {
-        fixture.options.isDebug = false
+        fixture.options.setDebug(false)
         fixture.options.setDiagnosticLevel(SentryLevel.FATAL)
         val sut = fixture.getSut()
         val expectedLevel = SentryLevel.ERROR
diff --git a/sentry/src/test/java/io/sentry/DirectoryProcessorTest.kt b/sentry/src/test/java/io/sentry/DirectoryProcessorTest.kt
@@ -29,7 +29,7 @@ class DirectoryProcessorTest {
         var options = SentryOptions().noFlushTimeout()
 
         init {
-            options.isDebug = true
+            options.setDebug(true)
             options.setLogger(logger)
         }
 
diff --git a/sentry/src/test/java/io/sentry/EnvelopeSenderTest.kt b/sentry/src/test/java/io/sentry/EnvelopeSenderTest.kt
@@ -26,7 +26,7 @@ class EnvelopeSenderTest {
         var options = SentryOptions().noFlushTimeout()
 
         init {
-            options.isDebug = true
+            options.setDebug(true)
             options.setLogger(logger)
         }
 
diff --git a/sentry/src/test/java/io/sentry/SendCachedEnvelopeFireAndForgetIntegrationTest.kt b/sentry/src/test/java/io/sentry/SendCachedEnvelopeFireAndForgetIntegrationTest.kt
@@ -15,7 +15,7 @@ class SendCachedEnvelopeFireAndForgetIntegrationTest {
         var callback = mock<SendCachedEnvelopeFireAndForgetIntegration.SendFireAndForgetFactory>()
 
         init {
-            options.isDebug = true
+            options.setDebug(true)
             options.setLogger(logger)
         }
 
diff --git a/sentry/src/test/java/io/sentry/SentryClientTest.kt b/sentry/src/test/java/io/sentry/SentryClientTest.kt
@@ -57,7 +57,7 @@ class SentryClientTest {
                 name = "test"
                 version = "1.2.3"
             }
-            isDebug = true
+            setDebug(true)
             setDiagnosticLevel(SentryLevel.DEBUG)
             setSerializer(GsonSerializer(mock(), envelopeReader))
             setLogger(mock())
diff --git a/sentry/src/test/java/io/sentry/SentryOptionsTest.kt b/sentry/src/test/java/io/sentry/SentryOptionsTest.kt
@@ -336,6 +336,63 @@ class SentryOptionsTest {
         }
     }
 
+    @Test
+    fun `creates options with debug set to true enabled using external properties`() {
+        // create a sentry.properties file in temporary folder
+        val temporaryFolder = TemporaryFolder()
+        temporaryFolder.create()
+        val file = temporaryFolder.newFile("sentry.properties")
+        file.appendText("debug=true")
+        // set location of the sentry.properties file
+        System.setProperty("sentry.properties.file", file.absolutePath)
+
+        try {
+            val options = SentryOptions.from(PropertiesProviderFactory.create())
+            assertTrue(options.isDebug)
+        } finally {
+            temporaryFolder.delete()
+        }
+    }
+
+    @Test
+    fun `creates options with debug set to false enabled using external properties`() {
+        // create a sentry.properties file in temporary folder
+        val temporaryFolder = TemporaryFolder()
+        temporaryFolder.create()
+        val file = temporaryFolder.newFile("sentry.properties")
+        file.appendText("debug=false")
+        // set location of the sentry.properties file
+        System.setProperty("sentry.properties.file", file.absolutePath)
+
+        try {
+            val options = SentryOptions.from(PropertiesProviderFactory.create())
+            assertFalse(options.isDebug)
+        } finally {
+            temporaryFolder.delete()
+        }
+    }
+
+    @Test
+    fun `creates options with debug set to null enabled using external properties`() {
+        // create a sentry.properties file in temporary folder
+        val temporaryFolder = TemporaryFolder()
+        temporaryFolder.create()
+        val file = temporaryFolder.newFile("sentry.properties")
+        // set location of the sentry.properties file
+        System.setProperty("sentry.properties.file", file.absolutePath)
+
+        try {
+            val options = SentryOptions.from(PropertiesProviderFactory.create())
+            val mergeResult = SentryOptions().apply {
+                setDebug(true)
+            }
+            mergeResult.merge(options)
+            assertTrue(mergeResult.isDebug)
+        } finally {
+            temporaryFolder.delete()
+        }
+    }
+
     @Test
     fun `when options is initialized, Gson Serializer is set by default`() {
         assertTrue(SentryOptions().serializer is GsonSerializer)
diff --git a/sentry/src/test/java/io/sentry/SentryTest.kt b/sentry/src/test/java/io/sentry/SentryTest.kt
@@ -61,7 +61,7 @@ class SentryTest {
             it.dsn = dsn
             it.cacheDirPath = getTempPath()
             sentryOptions = it
-            it.isDebug = true
+            it.setDebug(true)
         }
 
         assertTrue((sentryOptions!!.logger as DiagnosticLogger).logger is SystemOutLogger)
@@ -99,7 +99,7 @@ class SentryTest {
         }
         Sentry.init {
             it.dsn = dsn
-            it.isDebug = true
+            it.setDebug(true)
             it.setLogger(logger)
         }
         verify(logger).log(eq(SentryLevel.WARNING), eq("Sentry has been already initialized. Previous configuration will be overwritten."))
diff --git a/sentry/src/test/java/io/sentry/cache/EnvelopeCacheTest.kt b/sentry/src/test/java/io/sentry/cache/EnvelopeCacheTest.kt
@@ -42,7 +42,7 @@ class EnvelopeCacheTest {
 
             options.setLogger(logger)
             options.setSerializer(serializer)
-            options.isDebug = true
+            options.setDebug(true)
 
             return EnvelopeCache(options)
         }

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class EnvelopeFileObserverTest {`
`33`	`33`	`val envelopeSender = mock<IEnvelopeSender>()`
`34`	`34`	`val logger = mock<ILogger>()`
`35`	`35`	`val options = SentryOptions().apply {`
`36`		`- isDebug = true`
	`36`	`+ setDebug(true)`
`37`	`37`	`setLogger(logger)`
`38`	`38`	`}`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ class NdkIntegrationTest {`
`122`	`122`	`private fun getOptions(enableNdk: Boolean = true, logger: ILogger = mock(), cacheDir: String? = "abc"): SentryAndroidOptions {`
`123`	`123`	`return SentryAndroidOptions().apply {`
`124`	`124`	`setLogger(logger)`
`125`		`- isDebug = true`
	`125`	`+ setDebug(true)`
`126`	`126`	`isEnableNdk = enableNdk`
`127`	`127`	`cacheDirPath = cacheDir`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class DirectoryProcessorTest {`
`29`	`29`	`var options = SentryOptions().noFlushTimeout()`
`30`	`30`
`31`	`31`	`init {`
`32`		`- options.isDebug = true`
	`32`	`+ options.setDebug(true)`
`33`	`33`	`options.setLogger(logger)`
`34`	`34`	`}`
`35`	`35`