DebuggerSettingsTests.cs

// <copyright file="DebuggerSettingsTests.cs" company="Datadog">
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
// </copyright>

using Datadog.Trace.Configuration;
using Datadog.Trace.Configuration.Telemetry;
using Datadog.Trace.Debugger;
using FluentAssertions;
using Xunit;

namespace Datadog.Trace.Tests.Debugger
{
    public class DebuggerSettingsTests
    {
        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidMaxDepthToSerialize_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.MaxDepthToSerialize, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.MaximumDepthOfMembersToCopy.Should().Be(3);
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidSerializationTimeThreshold_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.MaxTimeToSerialize, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.MaxSerializationTimeInMilliseconds.Should().Be(200);
        }

        [Theory]
        [InlineData(null)]
        [InlineData("")]
        [InlineData("false")]
        public void DebuggerDisabled(string enabled)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.Enabled, enabled }, }),
                NullConfigurationTelemetry.Instance);

            settings.Enabled.Should().BeFalse();
        }

        [Theory]
        [InlineData(null)]
        [InlineData("")]
        [InlineData("false")]
        public void SymbolsDisabled(string enabled)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.SymbolDatabaseUploadEnabled, enabled }, }),
                NullConfigurationTelemetry.Instance);

            settings.SymbolDatabaseUploadEnabled.Should().BeFalse();
        }

        [Fact]
        public void DebuggerSettings_UseSettings()
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new()
                {
                    { ConfigurationKeys.Debugger.Enabled, "true" },
                    { ConfigurationKeys.Debugger.SymbolDatabaseUploadEnabled, "true" },
                    { ConfigurationKeys.Debugger.MaxDepthToSerialize, "100" },
                    { ConfigurationKeys.Debugger.MaxTimeToSerialize, "1000" },
                }),
                NullConfigurationTelemetry.Instance);

            settings.Enabled.Should().BeTrue();
            settings.SymbolDatabaseCompressionEnabled.Should().BeFalse();
            settings.SymbolDatabaseUploadEnabled.Should().BeTrue();
            settings.MaximumDepthOfMembersToCopy.Should().Be(100);
            settings.MaxSerializationTimeInMilliseconds.Should().Be(1000);
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidUploadBatchSize_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.UploadBatchSize, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.UploadBatchSize.Should().Be(100);
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidMaxSymbolSizeToUpload_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.SymbolDatabaseBatchSizeInBytes, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.SymbolDatabaseBatchSizeInBytes.Should().Be(100000);
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidDiagnosticsInterval_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.DiagnosticsInterval, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.DiagnosticsIntervalSeconds.Should().Be(3600);
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidUploadFlushInterval_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.UploadFlushInterval, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.UploadFlushIntervalMilliseconds.Should().Be(0);
        }

        [Theory]
        [InlineData("")]
        [InlineData("False")]
        [InlineData("false")]
        [InlineData("0")]
        [InlineData("2")]
        [InlineData(null)]
        public void CodeOriginEnabled_False(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.CodeOriginForSpansEnabled, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.CodeOriginForSpansEnabled.Should().BeFalse();
        }

        [Theory]
        [InlineData("True")]
        [InlineData("true")]
        [InlineData("1")]
        public void CodeOriginEnabled_True(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.CodeOriginForSpansEnabled, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.CodeOriginForSpansEnabled.Should().BeTrue();
        }

        [Theory]
        [InlineData("8")]
        [InlineData("1")]
        [InlineData("1000")]
        public void CodeOriginMaxUserFrames(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.CodeOriginMaxUserFrames, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.CodeOriginMaxUserFrames.Should().Be(int.Parse(value));
        }

        [Theory]
        [InlineData("-1")]
        [InlineData("0")]
        [InlineData("")]
        [InlineData(null)]
        public void InvalidCodeOriginMaxUserFrames_DefaultUsed(string value)
        {
            var settings = new DebuggerSettings(
                new NameValueConfigurationSource(new() { { ConfigurationKeys.Debugger.CodeOriginMaxUserFrames, value }, }),
                NullConfigurationTelemetry.Instance);

            settings.CodeOriginMaxUserFrames.Should().Be(8);
        }
    }
}