Add logfile actuator

src/Management/src/Endpoint/Actuators/All/EndpointServiceCollectionExtensions.cs

@@ -12,6 +12,7 @@
 using Steeltoe.Management.Endpoint.Actuators.HttpExchanges;
 using Steeltoe.Management.Endpoint.Actuators.Hypermedia;
 using Steeltoe.Management.Endpoint.Actuators.Info;
+using Steeltoe.Management.Endpoint.Actuators.Logfile;
 using Steeltoe.Management.Endpoint.Actuators.Loggers;
 using Steeltoe.Management.Endpoint.Actuators.Refresh;
 using Steeltoe.Management.Endpoint.Actuators.RouteMappings;
@@ -70,6 +71,7 @@ public static IServiceCollection AddAllActuators(this IServiceCollection service
         services.AddRouteMappingsActuator(configureMiddleware);
         services.AddRefreshActuator(configureMiddleware);
         services.AddServicesActuator(configureMiddleware);
+        services.AddLogFileActuator(configureMiddleware);
 
         return services;
     }

src/Management/src/Endpoint/Actuators/LogFile/ConfigureLogFileEndpointOptions.cs

@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.Extensions.Configuration;
+using Steeltoe.Management.Endpoint.Configuration;
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+internal sealed class ConfigureLogFileEndpointOptions : ConfigureEndpointOptions<LogFileEndpointOptions>
+{
+    private const string ManagementInfoPrefix = "management:endpoints:logfile";
+
+    public ConfigureLogFileEndpointOptions(IConfiguration configuration)
+        : base(configuration, ManagementInfoPrefix, "logfile")
+    {
+        ArgumentNullException.ThrowIfNull(configuration);
+    }
+
+    public override void Configure(LogFileEndpointOptions options)
+    {
+        ArgumentNullException.ThrowIfNull(options);
+
+        base.Configure(options);
+    }
+}

src/Management/src/Endpoint/Actuators/LogFile/EndpointServiceCollectionExtensions.cs

@@ -0,0 +1,51 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Hosting;
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+public static class EndpointServiceCollectionExtensions
+{
+    /// <summary>
+    /// Adds the logfile actuator to the service container and configure the ASP.NET Core middleware pipeline.
+    /// </summary>
+    /// <param name="services">
+    /// The <see cref="IServiceCollection" /> to add services to.
+    /// </param>
+    /// <returns>
+    /// The incoming <paramref name="services" /> so that additional calls can be chained.
+    /// </returns>
+    public static IServiceCollection AddLogFileActuator(this IServiceCollection services)
+    {
+        return AddLogFileActuator(services, true);
+    }
+
+    /// <summary>
+    /// Adds the logfile actuator to the service container.
+    /// </summary>
+    /// <param name="services">
+    /// The <see cref="IServiceCollection" /> to add services to.
+    /// </param>
+    /// <param name="configureMiddleware">
+    /// When <c>false</c>, skips configuration of the ASP.NET Core middleware pipeline. While this provides full control over the pipeline order, it requires
+    /// manual addition of the appropriate middleware for actuators to work correctly.
+    /// </param>
+    /// <returns>
+    /// The incoming <paramref name="services" /> so that additional calls can be chained.
+    /// </returns>
+    public static IServiceCollection AddLogFileActuator(this IServiceCollection services, bool configureMiddleware)
+    {
+        ArgumentNullException.ThrowIfNull(services);
+
+        services.TryAddSingleton<IHostEnvironment>(serviceProvider => serviceProvider.GetService<IHostEnvironment>()!);
+
+        services.AddCoreActuatorServices<LogFileEndpointOptions, ConfigureLogFileEndpointOptions, LogFileEndpointMiddleware,
+            ILogFileEndpointHandler, LogFileEndpointHandler, object?, string>(configureMiddleware);
+
+        return services;
+    }
+}

src/Management/src/Endpoint/Actuators/LogFile/ILogFileEndpointHandler.cs

@@ -0,0 +1,7 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+public interface ILogFileEndpointHandler : IEndpointHandler<object?, string>;

src/Management/src/Endpoint/Actuators/LogFile/LogFileEndpointHandler.cs

@@ -0,0 +1,57 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using System.Reflection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Steeltoe.Management.Configuration;
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+public sealed class LogFileEndpointHandler : ILogFileEndpointHandler
+{
+    private readonly IOptionsMonitor<LogFileEndpointOptions> _optionsMonitor;
+    private readonly ILogger<LogFileEndpointHandler> _logger;
+
+    public EndpointOptions Options => _optionsMonitor.CurrentValue;
+
+    public LogFileEndpointHandler(IOptionsMonitor<LogFileEndpointOptions> optionsMonitorMonitor, ILoggerFactory loggerFactory)
+    {
+        ArgumentNullException.ThrowIfNull(optionsMonitorMonitor);
+        ArgumentNullException.ThrowIfNull(loggerFactory);
+
+        _optionsMonitor = optionsMonitorMonitor;
+        _logger = loggerFactory.CreateLogger<LogFileEndpointHandler>();
+    }
+
+    public async Task<string> InvokeAsync(object? argument, CancellationToken cancellationToken)
+    {
+        _logger.LogTrace("Invoking LogfileEndpointHandler with argument: {Argument}", argument);
+        cancellationToken.ThrowIfCancellationRequested();
+
+        string logFilePath = GetLogFilePath();
+
+        if (!string.IsNullOrEmpty(logFilePath))
+        {
+            return await File.ReadAllTextAsync(logFilePath, cancellationToken);
+        }
+
+        _logger.LogWarning("Log file path is not set");
+        return string.Empty;
+    }
+
+    internal string GetLogFilePath()
+    {
+        _logger.LogTrace("Getting log file path");
+
+        if (!string.IsNullOrEmpty(_optionsMonitor.CurrentValue.FilePath))
+        {
+            string entryAssemblyDirectory = Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location)!;
+            return Path.Combine(entryAssemblyDirectory, _optionsMonitor.CurrentValue.FilePath ?? string.Empty);
+        }
+
+        _logger.LogWarning("File path is not set");
+        return string.Empty;
+    }
+}

src/Management/src/Endpoint/Actuators/LogFile/LogFileEndpointMiddleware.cs

@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Steeltoe.Management.Endpoint.Configuration;
+using Steeltoe.Management.Endpoint.Middleware;
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+internal sealed class LogFileEndpointMiddleware(
+    ILogFileEndpointHandler endpointHandler, IOptionsMonitor<ManagementOptions> managementOptionsMonitor, ILoggerFactory loggerFactory)
+    : EndpointMiddleware<object?, string>(endpointHandler, managementOptionsMonitor, loggerFactory)
+{
+    protected override async Task<string> InvokeEndpointHandlerAsync(object? request, CancellationToken cancellationToken)
+    {
+        return await EndpointHandler.InvokeAsync(request, cancellationToken);
+    }
+}

src/Management/src/Endpoint/Actuators/LogFile/LogFileEndpointOptions.cs

@@ -0,0 +1,16 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Steeltoe.Management.Configuration;
+
+namespace Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+public sealed class LogFileEndpointOptions : EndpointOptions
+{
+    /// <summary>
+    /// Gets or sets the file path to the log file on disk. The path can be absolute or relative to
+    /// <see cref="System.Reflection.Assembly.GetEntryAssembly()" />.
+    /// </summary>
+    public string? FilePath { get; set; }
+}

src/Management/src/Endpoint/PublicAPI.Unshipped.txt

@@ -38,6 +38,8 @@ static Steeltoe.Management.Endpoint.Actuators.Info.EndpointServiceCollectionExte
 static Steeltoe.Management.Endpoint.Actuators.Info.EndpointServiceCollectionExtensions.AddInfoActuator(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, bool configureMiddleware) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Steeltoe.Management.Endpoint.Actuators.Info.EndpointServiceCollectionExtensions.AddInfoContributor(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Type! infoContributorType) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Steeltoe.Management.Endpoint.Actuators.Info.EndpointServiceCollectionExtensions.AddInfoContributor<T>(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Steeltoe.Management.Endpoint.Actuators.LogFile.EndpointServiceCollectionExtensions.AddLogFileActuator(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Steeltoe.Management.Endpoint.Actuators.LogFile.EndpointServiceCollectionExtensions.AddLogFileActuator(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, bool configureMiddleware) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Steeltoe.Management.Endpoint.Actuators.Loggers.EndpointServiceCollectionExtensions.AddLoggersActuator(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Steeltoe.Management.Endpoint.Actuators.Loggers.EndpointServiceCollectionExtensions.AddLoggersActuator(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, bool configureMiddleware) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Steeltoe.Management.Endpoint.Actuators.Loggers.LoggersResponse.Error.get -> Steeltoe.Management.Endpoint.Actuators.Loggers.LoggersResponse!
@@ -262,6 +264,16 @@ Steeltoe.Management.Endpoint.Actuators.Info.InfoBuilder.WithInfo(string! key, ob
 Steeltoe.Management.Endpoint.Actuators.Info.InfoBuilder.WithInfo(System.Collections.Generic.IDictionary<string!, object!>! details) -> Steeltoe.Management.Endpoint.Actuators.Info.InfoBuilder!
 Steeltoe.Management.Endpoint.Actuators.Info.InfoEndpointOptions
 Steeltoe.Management.Endpoint.Actuators.Info.InfoEndpointOptions.InfoEndpointOptions() -> void
+Steeltoe.Management.Endpoint.Actuators.LogFile.EndpointServiceCollectionExtensions
+Steeltoe.Management.Endpoint.Actuators.LogFile.ILogFileEndpointHandler
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointHandler
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointHandler.InvokeAsync(object? argument, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<string!>!
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointHandler.LogFileEndpointHandler(Microsoft.Extensions.Options.IOptionsMonitor<Steeltoe.Management.Endpoint.Actuators.Logfile.LogfileEndpointOptions!>! optionsMonitorMonitor, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory) -> void
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointHandler.Options.get -> Steeltoe.Management.Configuration.EndpointOptions!
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointOptions
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointOptions.FilePath.get -> string?
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointOptions.FilePath.set -> void
+Steeltoe.Management.Endpoint.Actuators.LogFile.LogFileEndpointOptions.LogFileEndpointOptions() -> void
 Steeltoe.Management.Endpoint.Actuators.Loggers.EndpointServiceCollectionExtensions
 Steeltoe.Management.Endpoint.Actuators.Loggers.ILoggersEndpointHandler
 Steeltoe.Management.Endpoint.Actuators.Loggers.LoggerGroup

src/Management/test/Endpoint.Test/Actuators/CloudFoundry/EndpointMiddlewareTest.cs

@@ -53,9 +53,10 @@ public async Task CloudFoundryEndpointMiddleware_ReturnsExpectedData()
         links.Entries["refresh"].Href.Should().Be("http://localhost/cloudfoundryapplication/refresh");
         links.Entries["mappings"].Href.Should().Be("http://localhost/cloudfoundryapplication/mappings");
         links.Entries["loggers"].Href.Should().Be("http://localhost/cloudfoundryapplication/loggers");
+        links.Entries["logfile"].Href.Should().Be("http://localhost/cloudfoundryapplication/logfile");
         links.Entries["self"].Href.Should().Be("http://localhost/cloudfoundryapplication");
         links.Entries["threaddump"].Href.Should().Be("http://localhost/cloudfoundryapplication/threaddump");
-        links.Entries.Should().HaveCount(12);
+        links.Entries.Should().HaveCount(13);
     }
 
     [Fact]
@@ -119,6 +120,10 @@ public async Task CloudFoundryEndpointMiddleware_ServiceContractNotBroken()
                   "href": "http://localhost/cloudfoundryapplication/beans",
                   "templated": false
                 },
+                "logfile": {
+                  "href": "http://localhost/cloudfoundryapplication/logfile",
+                  "templated": false
+                },
                 "self": {
                   "href": "http://localhost/cloudfoundryapplication",
                   "templated": false

src/Management/test/Endpoint.Test/Actuators/LogFile/EndpointMiddlewareTest.cs

@@ -0,0 +1,50 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using System.Net;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.Configuration;
+using Steeltoe.Common.TestResources;
+using Steeltoe.Common.TestResources.IO;
+
+namespace Steeltoe.Management.Endpoint.Test.Actuators.Logfile;
+
+public sealed class EndpointMiddlewareTest : BaseTest
+{
+    private static readonly Dictionary<string, string?> AppSettings = new()
+    {
+        ["Logging:Console:IncludeScopes"] = "false",
+        ["Logging:LogLevel:Default"] = "Warning",
+        ["Logging:LogLevel:TestApp"] = "Information",
+        ["Logging:LogLevel:Steeltoe"] = "Information",
+        ["management:endpoints:enabled"] = "true",
+        ["management:endpoints:actuator:exposure:include:0"] = "*"
+    };
+
+    private readonly TempFile _tempLogFile = new();
+
+    [Fact]
+    public async Task LogFileActuator_ReturnsExpectedData()
+    {
+        AppSettings["management:endpoints:logfile:filePath"] = _tempLogFile.FullPath;
+        await File.WriteAllTextAsync(_tempLogFile.FullPath, "This is a test log.");
+
+        WebHostBuilder builder = TestWebHostBuilderFactory.Create();
+        builder.UseStartup<Startup>();
+        builder.ConfigureAppConfiguration((_, configuration) => configuration.AddInMemoryCollection(AppSettings));
+
+        using IWebHost app = builder.Build();
+        await app.StartAsync();
+
+        using HttpClient client = app.GetTestClient();
+        HttpResponseMessage response = await client.GetAsync(new Uri("http://localhost/actuator/logfile"));
+        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+
+        string actualLogContent = await response.Content.ReadAsStringAsync();
+
+        // assert
+        actualLogContent.Trim().Should().BeEquivalentTo("\"This is a test log.\"");
+    }
+}

src/Management/test/Endpoint.Test/Actuators/LogFile/EndpointServiceCollectionTest.cs

@@ -0,0 +1,41 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+namespace Steeltoe.Management.Endpoint.Test.Actuators.Logfile;
+
+public sealed class EndpointServiceCollectionTest : BaseTest
+{
+    [Fact]
+    public async Task AddLogFileActuator_AddsCorrectServices()
+    {
+        var services = new ServiceCollection();
+        services.AddSingleton(TestHostEnvironmentFactory.Create());
+
+        var appSettings = new Dictionary<string, string?>
+        {
+            ["management:endpoints:logfile:path"] = "/some",
+            ["management:endpoints:logfile:filePath"] = "/var/logs/app.log"
+        };
+
+        var configurationBuilder = new ConfigurationBuilder();
+        configurationBuilder.AddInMemoryCollection(appSettings);
+        IConfiguration configuration = configurationBuilder.Build();
+
+        services.AddSingleton(configuration);
+        services.AddLogging();
+        services.AddLogFileActuator();
+        await using ServiceProvider serviceProvider = services.BuildServiceProvider(true);
+
+        var options = serviceProvider.GetRequiredService<IOptionsMonitor<LogFileEndpointOptions>>();
+        Assert.Equal("/some", options.CurrentValue.Path);
+
+        var handler = serviceProvider.GetService<ILogFileEndpointHandler>();
+        Assert.NotNull(handler);
+    }
+}

src/Management/test/Endpoint.Test/Actuators/LogFile/LogFileEndpointOptionsTest.cs

@@ -0,0 +1,44 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using Steeltoe.Management.Configuration;
+using Steeltoe.Management.Endpoint.Actuators.Logfile;
+
+namespace Steeltoe.Management.Endpoint.Test.Actuators.Logfile;
+
+public sealed class LogFileEndpointOptionsTest : BaseTest
+{
+    [Fact]
+    public void AppliesDefaults()
+    {
+        LogFileEndpointOptions options = GetOptionsFromSettings<LogFileEndpointOptions, ConfigureLogFileEndpointOptions>();
+
+        options.Id.Should().Be("logfile");
+        options.RequiredPermissions.Should().Be(EndpointPermissions.Restricted);
+        options.Path.Should().Be("logfile");
+        options.FilePath.Should().BeNull();
+        options.AllowedVerbs.Should().Contain("Get");
+        options.AllowedVerbs.Should().HaveCount(1);
+    }
+
+    [Fact]
+    public void CanOverrideDefaults()
+    {
+        var appSettings = new Dictionary<string, string?>
+        {
+            ["management:endpoints:logfile:path"] = "testPath",
+            ["management:endpoints:logfile:filePath"] = "logs/application.log"
+        };
+
+        LogFileEndpointOptions options = GetOptionsFromSettings<LogFileEndpointOptions, ConfigureLogFileEndpointOptions>(appSettings);
+
+        options.Id.Should().Be("logfile");
+        options.RequiredPermissions.Should().Be(EndpointPermissions.Restricted);
+        options.Path.Should().Be("testPath");
+        options.AllowedVerbs.Should().Contain("Get");
+        options.FilePath.Should().Be("logs/application.log");
+        options.AllowedVerbs.Should().Contain("Get");
+        options.AllowedVerbs.Should().HaveCount(1);
+    }
+}