Skip to content

Commit

Permalink
adding loglevel acceptance tests, verifying that the logs are returne…
Browse files Browse the repository at this point in the history 
…d according to the minimum log level set in appsettings
  • Loading branch information
@ggnaegi
ggnaegi committed Oct 27, 2023
1 parent 0d3c38c commit c4f6dc9
Show file tree
Hide file tree
Showing 2 changed files with 390 additions and 4 deletions.
388 changes: 388 additions & 0 deletions test/Ocelot.AcceptanceTests/LogLevelTests.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,388 @@
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Ocelot.Configuration.File;
using Serilog;
using Serilog.Core;

namespace Ocelot.AcceptanceTests;

public class LogLevelTests : IDisposable
{
private readonly Steps _steps;
private readonly ServiceHandler _serviceHandler;
private readonly string _logFileName;
private readonly string _appSettingsFileName;

private const string CriticalLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Critical\",\"System\":\"Critical\",\"Microsoft\":\"Critical\"}}}";
private const string ErrorLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Error\",\"System\":\"Error\",\"Microsoft\":\"Error\"}}}";
private const string WarningLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Warning\",\"System\":\"Warning\",\"Microsoft\":\"Warning\"}}}";
private const string InformationLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Information\",\"System\":\"Information\",\"Microsoft\":\"Information\"}}}";
private const string DebugLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Debug\",\"System\":\"Debug\",\"Microsoft\":\"Debug\"}}}";
private const string TraceLevelAppSettings =
"{\"Logging\":{\"LogLevel\":{\"Default\":\"Trace\",\"System\":\"Trace\",\"Microsoft\":\"Trace\"}}}";

public LogLevelTests()
{
_steps = new Steps();
_serviceHandler = new ServiceHandler();
_logFileName = $"ocelot_logs_{Guid.NewGuid()}.log";
_appSettingsFileName = $"appsettings_{Guid.NewGuid()}.json";
}

[Fact]
public void if_minimum_log_level_is_critical_then_only_critical_messages_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Critical);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(new[] { "TRACE", "INFORMATION", "WARNING", "ERROR" }, new[] { "CRITICAL" }))
.BDDfy();
}

private void ThenMessagesAreLogged(string[] notAllowedMessageTypes, string[] allowedMessageTypes)
{
var logFilePath = GetLogFilePath();
var logFileContent = File.ReadAllText(logFilePath);
var logFileLines = logFileContent.Split(Environment.NewLine);

var logFileLinesWithLogLevel = logFileLines.Where(x => notAllowedMessageTypes.Any(x.Contains)).ToList();
logFileLinesWithLogLevel.Count.ShouldBe(0);

var logFileLinesWithAllowedLogLevel = logFileLines.Where(x => allowedMessageTypes.Any(x.Contains)).ToList();
logFileLinesWithAllowedLogLevel.Count.ShouldBe(2*allowedMessageTypes.Length);
}

[Fact]
public void if_minimum_log_level_is_error_then_critical_and_error_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Error);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(new[] { "TRACE", "INFORMATION", "WARNING", "DEBUG" }, new[] { "CRITICAL", "ERROR" }))
.BDDfy();
}

[Fact]
public void if_minimum_log_level_is_warning_then_critical_error_and_warning_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Warning);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(new[] { "TRACE", "INFORMATION", "DEBUG" }, new[] { "CRITICAL", "ERROR", "WARNING" }))
.BDDfy();
}

[Fact]
public void if_minimum_log_level_is_information_then_critical_error_warning_and_information_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Information);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(new[] { "TRACE", "DEBUG" }, new[] { "CRITICAL", "ERROR", "WARNING", "INFORMATION" }))
.BDDfy();
}

[Fact]
public void if_minimum_log_level_is_debug_then_critical_error_warning_information_and_debug_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Debug);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(new []{ "TRACE" }, new[] { "DEBUG", "CRITICAL", "ERROR", "WARNING", "INFORMATION" }))
.BDDfy();
}

[Fact]
public void if_minimum_log_level_is_trace_then_critical_error_warning_information_debug_and_trace_are_logged()
{
var port = RandomPortFinder.GetRandomPort();
var configuration = new FileConfiguration
{
Routes = new List<FileRoute>
{
new()
{
DownstreamPathTemplate = "/",
DownstreamHostAndPorts = new List<FileHostAndPort>
{
new()
{
Host = "localhost",
Port = port,
},
},
DownstreamScheme = "http",
UpstreamPathTemplate = "/",
UpstreamHttpMethod = new List<string> { "Get" },
RequestIdKey = _steps.RequestIdKey,
},
},
};

var logger = GetLogger(LogLevel.Trace);
this.Given(x => x.GivenThereIsAServiceRunningOn($"http://localhost:{port}"))
.And(x => _steps.GivenThereIsAConfiguration(configuration))
.And(x => _steps.GivenOcelotIsRunningWithMinimumLogLevel(logger, _appSettingsFileName))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.When(x => _steps.WhenIGetUrlOnTheApiGateway("/"))
.Then(x => _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK))
.Then(x => _steps.Dispose())
.Then(x => DisposeLogger(logger))
.Then(x => ThenMessagesAreLogged(Array.Empty<string>(), new[] { "DEBUG", "CRITICAL", "ERROR", "WARNING", "INFORMATION", "TRACE" }))
.BDDfy();
}

private Logger GetLogger(LogLevel logLevel)
{
var logFilePath = ResetLogFile();
UpdateAppSettings(logLevel);
var logger = logLevel switch
{
LogLevel.Information => new LoggerConfiguration().MinimumLevel.Information()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.Warning => new LoggerConfiguration().MinimumLevel.Warning()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.Error => new LoggerConfiguration().MinimumLevel.Error()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.Critical => new LoggerConfiguration().MinimumLevel.Fatal()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.Debug => new LoggerConfiguration().MinimumLevel.Debug()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.Trace => new LoggerConfiguration().MinimumLevel.Verbose()
.WriteTo.File(logFilePath)
.CreateLogger(),
LogLevel.None => new LoggerConfiguration()
.WriteTo.File(logFilePath)
.CreateLogger(),
_ => throw new ArgumentOutOfRangeException(nameof(logLevel), logLevel, null),
};
return logger;
}

private void UpdateAppSettings(LogLevel logLevel)
{
var appSettingsFilePath = Path.Combine(AppContext.BaseDirectory, _appSettingsFileName);
if (File.Exists(appSettingsFilePath))
{
File.Delete(appSettingsFilePath);
}

var appSettings = logLevel switch
{
LogLevel.Information => InformationLevelAppSettings,
LogLevel.Warning => WarningLevelAppSettings,
LogLevel.Error => ErrorLevelAppSettings,
LogLevel.Critical => CriticalLevelAppSettings,
LogLevel.Debug => DebugLevelAppSettings,
LogLevel.Trace => TraceLevelAppSettings,
LogLevel.None => string.Empty,
_ => throw new ArgumentOutOfRangeException(nameof(logLevel), logLevel, null),
};
File.WriteAllText(appSettingsFilePath, appSettings);
}

private void DisposeLogger(Logger logger)
{
logger.Dispose();
}

private string ResetLogFile()
{
var logFilePath = GetLogFilePath();
if (File.Exists(logFilePath))
{
File.Delete(logFilePath);
}

return logFilePath;
}

private string GetLogFilePath()
{
var logFilePath = Path.Combine(AppContext.BaseDirectory, _logFileName);
return logFilePath;
}

private void GivenThereIsAServiceRunningOn(string baseUrl)
{
_serviceHandler.GivenThereIsAServiceRunningOn(baseUrl, async context =>
{
context.Response.StatusCode = 200;
await context.Response.WriteAsync(string.Empty);
});
}

public void Dispose()
{
_serviceHandler?.Dispose();
_steps.Dispose();
ResetLogFile();
GC.SuppressFinalize(this);
}
}
Loading

0 comments on commit c4f6dc9

Please sign in to comment.