diff --git a/src/Common/src/Common/HealthChecks/HealthCheckResult.cs b/src/Common/src/Common/HealthChecks/HealthCheckResult.cs index 473c5e9936..8d967097e6 100644 --- a/src/Common/src/Common/HealthChecks/HealthCheckResult.cs +++ b/src/Common/src/Common/HealthChecks/HealthCheckResult.cs @@ -19,6 +19,7 @@ public sealed class HealthCheckResult /// /// Used by the health middleware to determine the HTTP Status code. /// + [JsonPropertyName("status")] [JsonConverter(typeof(SnakeCaseAllCapsEnumMemberJsonConverter))] public HealthStatus Status { get; set; } = HealthStatus.Unknown; @@ -28,11 +29,13 @@ public sealed class HealthCheckResult /// /// Currently only used on check failures. /// + [JsonPropertyName("description")] public string? Description { get; set; } /// /// Gets details of the health check. /// + [JsonPropertyName("details")] [JsonIgnoreEmptyCollection] public IDictionary Details { get; } = new Dictionary(); } diff --git a/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs b/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs index a2a64797d2..2a93ec848b 100644 --- a/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs +++ b/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs @@ -5,7 +5,6 @@ using System.Runtime.InteropServices; using System.Security.Cryptography; using System.Security.Cryptography.X509Certificates; -using System.Text.Json; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Options; @@ -212,19 +211,25 @@ public async Task CertificateOptions_update_on_changed_path(string certificateNa private static string BuildAppSettingsJson(string certificateName, string certificatePath, string keyPath) { - string certificateBlock = $""" - "CertificateFilePath": {JsonSerializer.Serialize(certificatePath)}, - "PrivateKeyFilePath": {JsonSerializer.Serialize(keyPath)} - """; - - string namedCertificateSection = string.IsNullOrEmpty(certificateName) - ? certificateBlock - : $"{JsonSerializer.Serialize(certificateName)}: {{ {certificateBlock} }}"; + string escapedCertificatePath = certificatePath.Replace(@"\", @"\\", StringComparison.Ordinal); + string escapedKeyPath = keyPath.Replace(@"\", @"\\", StringComparison.Ordinal); - return $$""" + return string.IsNullOrEmpty(certificateName) + ? $$""" + { + "Certificates": { + "CertificateFilePath": "{{escapedCertificatePath}}", + "PrivateKeyFilePath": "{{escapedKeyPath}}" + } + } + """ + : $$""" { "Certificates": { - {{namedCertificateSection}} + "{{certificateName}}": { + "CertificateFilePath": "{{escapedCertificatePath}}", + "PrivateKeyFilePath": "{{escapedKeyPath}}" + } } } """; diff --git a/src/Discovery/src/Eureka/AppInfo/ApplicationInfo.cs b/src/Discovery/src/Eureka/AppInfo/ApplicationInfo.cs index df11be4347..257a55202d 100644 --- a/src/Discovery/src/Eureka/AppInfo/ApplicationInfo.cs +++ b/src/Discovery/src/Eureka/AppInfo/ApplicationInfo.cs @@ -53,7 +53,7 @@ private List GetInstancesSnapshot() /// public override string ToString() { - return JsonSerializer.Serialize(this, DebugSerializerOptions.Instance); + return JsonSerializer.Serialize(this, DebugJsonSerializerContext.Default.ApplicationInfo); } internal void Add(InstanceInfo instance) diff --git a/src/Discovery/src/Eureka/AppInfo/ApplicationInfoCollection.cs b/src/Discovery/src/Eureka/AppInfo/ApplicationInfoCollection.cs index 28e0fdbae6..e42f48370e 100644 --- a/src/Discovery/src/Eureka/AppInfo/ApplicationInfoCollection.cs +++ b/src/Discovery/src/Eureka/AppInfo/ApplicationInfoCollection.cs @@ -73,7 +73,7 @@ internal ReadOnlyCollection GetInstancesByVipAddress(string vipAdd /// public override string ToString() { - return JsonSerializer.Serialize(this, DebugSerializerOptions.Instance); + return JsonSerializer.Serialize(this, DebugJsonSerializerContext.Default.ApplicationInfoCollection); } IEnumerator IEnumerable.GetEnumerator() diff --git a/src/Discovery/src/Eureka/AppInfo/DataCenterName.cs b/src/Discovery/src/Eureka/AppInfo/DataCenterName.cs index 5cf05013d3..ede53c628b 100644 --- a/src/Discovery/src/Eureka/AppInfo/DataCenterName.cs +++ b/src/Discovery/src/Eureka/AppInfo/DataCenterName.cs @@ -6,8 +6,11 @@ #pragma warning disable SA1602 // Enumeration items should be documented #endif +using System.Text.Json.Serialization; + namespace Steeltoe.Discovery.Eureka.AppInfo; +[JsonConverter(typeof(JsonStringEnumConverter))] public enum DataCenterName { Netflix, diff --git a/src/Discovery/src/Eureka/AppInfo/InstanceInfo.cs b/src/Discovery/src/Eureka/AppInfo/InstanceInfo.cs index d89d9e6aae..0015f8078e 100644 --- a/src/Discovery/src/Eureka/AppInfo/InstanceInfo.cs +++ b/src/Discovery/src/Eureka/AppInfo/InstanceInfo.cs @@ -268,7 +268,7 @@ public override int GetHashCode() /// public override string ToString() { - return JsonSerializer.Serialize(this, DebugSerializerOptions.Instance); + return JsonSerializer.Serialize(this, DebugJsonSerializerContext.Default.InstanceInfo); } internal static InstanceInfo FromConfiguration(EurekaInstanceOptions options, TimeProvider timeProvider) diff --git a/src/Discovery/src/Eureka/AppInfo/LeaseInfo.cs b/src/Discovery/src/Eureka/AppInfo/LeaseInfo.cs index ecab87747e..2a1d76b2f1 100644 --- a/src/Discovery/src/Eureka/AppInfo/LeaseInfo.cs +++ b/src/Discovery/src/Eureka/AppInfo/LeaseInfo.cs @@ -48,7 +48,7 @@ private LeaseInfo() /// public override string ToString() { - return JsonSerializer.Serialize(this, DebugSerializerOptions.Instance); + return JsonSerializer.Serialize(this, DebugJsonSerializerContext.Default.LeaseInfo); } internal static LeaseInfo? FromJson(JsonLeaseInfo? jsonLeaseInfo) diff --git a/src/Discovery/src/Eureka/EurekaClient.cs b/src/Discovery/src/Eureka/EurekaClient.cs index 47fa8b7de6..ad4b97e420 100644 --- a/src/Discovery/src/Eureka/EurekaClient.cs +++ b/src/Discovery/src/Eureka/EurekaClient.cs @@ -8,7 +8,6 @@ using System.Net.Http.Json; using System.Text; using System.Text.Json; -using System.Text.Json.Serialization; using Microsoft.AspNetCore.Http.Extensions; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; @@ -37,21 +36,6 @@ public sealed partial class EurekaClient private static readonly Task TaskOfNull = Task.FromResult(null); private static readonly TimeSpan GetAccessTokenTimeout = TimeSpan.FromSeconds(10); - private static readonly JsonSerializerOptions RequestSerializerOptions = new() - { - DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull - }; - - private static readonly JsonSerializerOptions ResponseSerializerOptions = new() - { - PropertyNamingPolicy = JsonNamingPolicy.CamelCase, - Converters = - { - new JsonApplicationConverter(), - new JsonInstanceInfoConverter() - } - }; - private readonly IHttpClientFactory _httpClientFactory; private readonly IOptionsMonitor _optionsMonitor; private readonly EurekaServiceUriStateManager _eurekaServiceUriStateManager; @@ -98,7 +82,7 @@ public async Task RegisterAsync(InstanceInfo instance, CancellationToken cancell string requestBody = JsonSerializer.Serialize(new JsonInstanceInfoRoot { Instance = instance.ToJson() - }, RequestSerializerOptions); + }, EurekaJsonSerializerContext.Default.JsonInstanceInfoRoot); string path = $"apps/{WebUtility.UrlEncode(instance.AppName)}"; await ExecuteRequestAsync(HttpMethod.Post, path, null, requestBody, cancellationToken); @@ -224,7 +208,7 @@ private async Task GetApplicationsAtPathAsync(string { return await ExecuteRequestAsync(HttpMethod.Get, path, null, null, async response => { - var root = await response.Content.ReadFromJsonAsync(ResponseSerializerOptions, cancellationToken); + JsonApplicationsRoot? root = await response.Content.ReadFromJsonAsync(EurekaJsonSerializerContext.Default.JsonApplicationsRoot, cancellationToken); return ApplicationInfoCollection.FromJson(root?.Applications, _timeProvider); }, cancellationToken); } diff --git a/src/Discovery/src/Eureka/Transport/DebugJsonSerializerContext.cs b/src/Discovery/src/Eureka/Transport/DebugJsonSerializerContext.cs new file mode 100644 index 0000000000..07fabaacc2 --- /dev/null +++ b/src/Discovery/src/Eureka/Transport/DebugJsonSerializerContext.cs @@ -0,0 +1,12 @@ +// 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.Text.Json.Serialization; +using Steeltoe.Discovery.Eureka.AppInfo; + +namespace Steeltoe.Discovery.Eureka.Transport; + +[JsonSourceGenerationOptions(WriteIndented = true, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] +[JsonSerializable(typeof(ApplicationInfoCollection))] +internal sealed partial class DebugJsonSerializerContext : JsonSerializerContext; diff --git a/src/Discovery/src/Eureka/Transport/DebugSerializerOptions.cs b/src/Discovery/src/Eureka/Transport/DebugSerializerOptions.cs deleted file mode 100644 index 4a75651bb1..0000000000 --- a/src/Discovery/src/Eureka/Transport/DebugSerializerOptions.cs +++ /dev/null @@ -1,20 +0,0 @@ -// 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.Text.Encodings.Web; -using System.Text.Json; -using System.Text.Json.Serialization; - -namespace Steeltoe.Discovery.Eureka.Transport; - -internal static class DebugSerializerOptions -{ - public static JsonSerializerOptions Instance { get; } = new() - { - WriteIndented = true, - Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, - DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, - ReferenceHandler = ReferenceHandler.IgnoreCycles - }; -} diff --git a/src/Discovery/src/Eureka/Transport/EurekaJsonSerializerContext.cs b/src/Discovery/src/Eureka/Transport/EurekaJsonSerializerContext.cs new file mode 100644 index 0000000000..861981f501 --- /dev/null +++ b/src/Discovery/src/Eureka/Transport/EurekaJsonSerializerContext.cs @@ -0,0 +1,14 @@ +// 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.Text.Json.Serialization; + +namespace Steeltoe.Discovery.Eureka.Transport; + +[JsonSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] +[JsonSerializable(typeof(JsonApplicationsRoot))] +[JsonSerializable(typeof(List))] +[JsonSerializable(typeof(JsonInstanceInfoRoot))] +[JsonSerializable(typeof(List))] +internal sealed partial class EurekaJsonSerializerContext : JsonSerializerContext; diff --git a/src/Discovery/src/Eureka/Transport/JsonApplicationConverter.cs b/src/Discovery/src/Eureka/Transport/JsonApplicationConverter.cs index 906aaa80f1..7129f7d517 100644 --- a/src/Discovery/src/Eureka/Transport/JsonApplicationConverter.cs +++ b/src/Discovery/src/Eureka/Transport/JsonApplicationConverter.cs @@ -13,10 +13,10 @@ internal sealed class JsonApplicationConverter : JsonConverter>(ref reader, options)!; + return JsonSerializer.Deserialize(ref reader, EurekaJsonSerializerContext.Default.ListJsonApplication)!; } - var application = JsonSerializer.Deserialize(ref reader, options); + JsonApplication? application = JsonSerializer.Deserialize(ref reader, EurekaJsonSerializerContext.Default.JsonApplication); return application != null ? [application] : []; } diff --git a/src/Discovery/src/Eureka/Transport/JsonInstanceInfoConverter.cs b/src/Discovery/src/Eureka/Transport/JsonInstanceInfoConverter.cs index 2b751a374c..56f2f21ed7 100644 --- a/src/Discovery/src/Eureka/Transport/JsonInstanceInfoConverter.cs +++ b/src/Discovery/src/Eureka/Transport/JsonInstanceInfoConverter.cs @@ -13,10 +13,10 @@ internal sealed class JsonInstanceInfoConverter : JsonConverter>(ref reader, options)!; + return JsonSerializer.Deserialize(ref reader, EurekaJsonSerializerContext.Default.ListJsonInstanceInfo)!; } - var instanceInfo = JsonSerializer.Deserialize(ref reader, options); + JsonInstanceInfo? instanceInfo = JsonSerializer.Deserialize(ref reader, EurekaJsonSerializerContext.Default.JsonInstanceInfo); return instanceInfo != null ? [instanceInfo] : []; } diff --git a/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesJsonSerializerContext.cs b/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesJsonSerializerContext.cs new file mode 100644 index 0000000000..3193aebbc5 --- /dev/null +++ b/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesJsonSerializerContext.cs @@ -0,0 +1,11 @@ +// 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.Text.Json.Serialization; + +namespace Steeltoe.Discovery.HttpClients.LoadBalancers; + +[JsonSourceGenerationOptions] +[JsonSerializable(typeof(ServiceInstancesResolver.JsonSerializableServiceInstance[]))] +internal sealed partial class ServiceInstancesJsonSerializerContext : JsonSerializerContext; diff --git a/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesResolver.cs b/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesResolver.cs index 6a13c24690..e1231d171d 100644 --- a/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesResolver.cs +++ b/src/Discovery/src/HttpClients/LoadBalancers/ServiceInstancesResolver.cs @@ -116,7 +116,8 @@ public async Task> ResolveInstancesAsync(string serviceI { if (cacheValue is { Length: > 0 }) { - var serializableInstances = JsonSerializer.Deserialize>(cacheValue); + JsonSerializableServiceInstance[]? serializableInstances = + JsonSerializer.Deserialize(cacheValue, ServiceInstancesJsonSerializerContext.Default.JsonSerializableServiceInstanceArray); if (serializableInstances != null) { @@ -127,10 +128,10 @@ public async Task> ResolveInstancesAsync(string serviceI return null; } - private static byte[] ToCacheValue(IEnumerable instances) + private static byte[] ToCacheValue(List instances) { JsonSerializableServiceInstance[] serializableInstances = instances.Select(JsonSerializableServiceInstance.CopyFrom).ToArray(); - return JsonSerializer.SerializeToUtf8Bytes(serializableInstances); + return JsonSerializer.SerializeToUtf8Bytes(serializableInstances, ServiceInstancesJsonSerializerContext.Default.JsonSerializableServiceInstanceArray); } [LoggerMessage(Level = LogLevel.Warning, Message = "No discovery clients are registered.")] @@ -142,7 +143,7 @@ private static byte[] ToCacheValue(IEnumerable instances) [LoggerMessage(Level = LogLevel.Error, Message = "Failed to get instances from {DiscoveryClient}.")] private partial void LogFailedToGetInstances(Exception exception, Type discoveryClient); - private sealed class JsonSerializableServiceInstance : IServiceInstance + internal sealed class JsonSerializableServiceInstance : IServiceInstance { // Trust that deserialized instances meet the IServiceInstance contract, so suppress nullability warnings. diff --git a/src/Discovery/test/Eureka.Test/AppInfo/ApplicationInfoCollectionTest.cs b/src/Discovery/test/Eureka.Test/AppInfo/ApplicationInfoCollectionTest.cs index 6648a50ce8..5dca00ae23 100644 --- a/src/Discovery/test/Eureka.Test/AppInfo/ApplicationInfoCollectionTest.cs +++ b/src/Discovery/test/Eureka.Test/AppInfo/ApplicationInfoCollectionTest.cs @@ -3,8 +3,11 @@ // See the LICENSE file in the project root for more information. using System.Collections.ObjectModel; +using FluentAssertions.Extensions; using Steeltoe.Discovery.Eureka.AppInfo; +using Steeltoe.Discovery.Eureka.Configuration; using Steeltoe.Discovery.Eureka.Transport; +using Steeltoe.Discovery.Eureka.Util; namespace Steeltoe.Discovery.Eureka.Test.AppInfo; @@ -797,4 +800,127 @@ public void FromJsonApplications_WithMissingInstanceId() app.Name.Should().Be("myApp"); app.Instances.Should().BeEmpty(); } + + [Fact] + public void ToString_ReturnsExpected() + { + var apps = new ApplicationInfoCollection([ + new ApplicationInfo("ServiceA", [ + new InstanceInfo("full-instance-001", "ServiceA", "prod-server-01.example.com", "10.20.30.40", new DataCenterInfo + { + Name = DataCenterName.Amazon + }, TimeProvider.System) + { + AppGroupName = "ServiceGroup", + Status = InstanceStatus.Up, + OverriddenStatus = InstanceStatus.OutOfService, + VipAddress = "service-a-vip", + SecureVipAddress = "service-a-secure-vip", + NonSecurePort = 8080, + IsNonSecurePortEnabled = true, + SecurePort = 8443, + IsSecurePortEnabled = true, + HomePageUrl = "http://prod-server-01.example.com:8080/", + StatusPageUrl = "http://prod-server-01.example.com:8080/actuator/info", + HealthCheckUrl = "http://prod-server-01.example.com:8080/actuator/health", + SecureHealthCheckUrl = "https://prod-server-01.example.com:8443/actuator/health", + LeaseInfo = LeaseInfo.FromJson(new JsonLeaseInfo + { + RenewalIntervalInSeconds = 30, + DurationInSeconds = 90, + RegistrationTimestamp = DateTimeConversions.ToJavaMilliseconds(15.June(2024).At(14, 30, 55, 123).AsUtc()), + LastRenewalTimestamp = DateTimeConversions.ToJavaMilliseconds(18.June(2024).At(23, 1, 27, 789).AsUtc()), + EvictionTimestamp = DateTimeConversions.ToJavaMilliseconds(19.June(2024).At(1, 1, 27, 789).AsUtc()), + ServiceUpTimestamp = DateTimeConversions.ToJavaMilliseconds(15.June(2024).At(14, 31, 2, 456).AsUtc()) + }), + ActionType = ActionType.Added, + Metadata = new Dictionary + { + ["datacenter"] = "us-east-1", + ["availability-zone"] = "us-east-1a", + ["version"] = "3.2.1", + ["environment"] = "production", + ["deployment"] = "blue", + ["team"] = "platform" + } + }, + new InstanceInfo("minimal-instance-001", "ServiceA", "prod-server-02.local", "10.20.30.41", new DataCenterInfo + { + Name = DataCenterName.Netflix + }, TimeProvider.System) + ]), + new ApplicationInfo("EmptyService") + ]); + + apps.ToString().Should().Be(""" + [ + { + "Name": "EmptyService", + "Instances": [] + }, + { + "Name": "ServiceA", + "Instances": [ + { + "InstanceId": "full-instance-001", + "AppName": "ServiceA", + "AppGroupName": "ServiceGroup", + "HostName": "prod-server-01.example.com", + "IPAddress": "10.20.30.40", + "DataCenterInfo": { + "Name": "Amazon" + }, + "VipAddress": "service-a-vip", + "SecureVipAddress": "service-a-secure-vip", + "NonSecurePort": 8080, + "IsNonSecurePortEnabled": true, + "SecurePort": 8443, + "IsSecurePortEnabled": true, + "Status": "UP", + "OverriddenStatus": "OUT_OF_SERVICE", + "EffectiveStatus": "OUT_OF_SERVICE", + "HomePageUrl": "http://prod-server-01.example.com:8080/", + "StatusPageUrl": "http://prod-server-01.example.com:8080/actuator/info", + "HealthCheckUrl": "http://prod-server-01.example.com:8080/actuator/health", + "SecureHealthCheckUrl": "https://prod-server-01.example.com:8443/actuator/health", + "LeaseInfo": { + "RenewalInterval": "00:00:30", + "Duration": "00:01:30", + "RegistrationTimeUtc": "2024-06-15T14:30:55.123Z", + "LastRenewalTimeUtc": "2024-06-18T23:01:27.789Z", + "EvictionTimeUtc": "2024-06-19T01:01:27.789Z", + "ServiceUpTimeUtc": "2024-06-15T14:31:02.456Z" + }, + "Metadata": { + "datacenter": "us-east-1", + "availability-zone": "us-east-1a", + "version": "3.2.1", + "environment": "production", + "deployment": "blue", + "team": "platform" + }, + "ActionType": "ADDED", + "IsDirty": false + }, + { + "InstanceId": "minimal-instance-001", + "AppName": "ServiceA", + "HostName": "prod-server-02.local", + "IPAddress": "10.20.30.41", + "DataCenterInfo": { + "Name": "Netflix" + }, + "NonSecurePort": 0, + "IsNonSecurePortEnabled": false, + "SecurePort": 0, + "IsSecurePortEnabled": false, + "EffectiveStatus": "UNKNOWN", + "Metadata": {}, + "IsDirty": false + } + ] + } + ] + """); + } } diff --git a/src/Discovery/test/Eureka.Test/Transport/EurekaClientTest.cs b/src/Discovery/test/Eureka.Test/Transport/EurekaClientTest.cs index 9e5958cacf..b69254588b 100644 --- a/src/Discovery/test/Eureka.Test/Transport/EurekaClientTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/EurekaClientTest.cs @@ -4,7 +4,7 @@ using System.Net; using System.Text; -using System.Text.Json; +using System.Text.Json.Nodes; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using RichardSzalay.MockHttp; @@ -327,7 +327,7 @@ public async Task RegisterAsync_SendsRequestToServer() { using var capturingLoggerProvider = new CapturingLoggerProvider(category => category.StartsWith("Steeltoe.", StringComparison.Ordinal)); - using JsonDocument requestDocument = JsonDocument.Parse(""" + string jsonRequest = JsonNode.Parse(""" { "instance": { "instanceId": "some", @@ -354,9 +354,7 @@ public async Task RegisterAsync_SendsRequestToServer() "lastDirtyTimestamp": "1708427732823" } } - """); - - string jsonRequest = JsonSerializer.Serialize(requestDocument); + """)!.ToJsonString(); var services = new ServiceCollection(); services.AddLogging(options => options.SetMinimumLevel(LogLevel.Trace).AddProvider(capturingLoggerProvider)); diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationRootTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationRootTest.cs deleted file mode 100644 index 5df09733ae..0000000000 --- a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationRootTest.cs +++ /dev/null @@ -1,72 +0,0 @@ -// 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.Text.Json; -using Steeltoe.Discovery.Eureka.Transport; - -namespace Steeltoe.Discovery.Eureka.Test.Transport; - -public sealed class JsonApplicationRootTest -{ - [Fact] - public void Deserialize_GoodJson() - { - const string json = """ - { - "application": { - "name": "FOO", - "instance": [ - { - "instanceId": "localhost:foo", - "hostName": "localhost", - "app": "FOO", - "ipAddr": "192.168.56.1", - "status": "UP", - "overriddenStatus": "UNKNOWN", - "port": { - "$": 8080, - "@enabled": "true" - }, - "securePort": { - "$": 443, - "@enabled": "false" - }, - "countryId": 1, - "dataCenterInfo": { - "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", - "name": "MyOwn" - }, - "leaseInfo": { - "renewalIntervalInSecs": 30, - "durationInSecs": 90, - "registrationTimestamp": 1458152330783, - "lastRenewalTimestamp": 1458243422342, - "evictionTimestamp": 0, - "serviceUpTimestamp": 1458152330783 - }, - "metadata": { - "@class": "java.util.Collections$EmptyMap" - }, - "homePageUrl": "http://localhost:8080/", - "statusPageUrl": "http://localhost:8080/info", - "healthCheckUrl": "http://localhost:8080/health", - "vipAddress": "foo", - "isCoordinatingDiscoveryServer": "false", - "lastUpdatedTimestamp": "1458152330783", - "lastDirtyTimestamp": "1458152330696", - "actionType": "ADDED" - } - ] - } - } - """; - - var result = JsonSerializer.Deserialize(json); - - result.Should().NotBeNull(); - result.Application.Should().NotBeNull(); - result.Application.Name.Should().Be("FOO"); - result.Application.Instances.Should().ContainSingle(); - } -} diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationTest.cs index 2bebc8ce36..e528bb2e64 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationTest.cs @@ -10,62 +10,48 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonApplicationTest { [Fact] - public void Deserialize_GoodJson() + public void Deserialize_InstanceArray() { const string json = """ { "name": "FOO", "instance": [ { - "instanceId": "localhost:foo", - "hostName": "localhost", - "app": "FOO", - "ipAddr": "192.168.56.1", - "status": "UP", - "overriddenStatus": "UNKNOWN", - "port": { - "$": 8080, - "@enabled": "true" - }, - "securePort": { - "$": 443, - "@enabled": "false" - }, - "countryId": 1, - "dataCenterInfo": { - "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", - "name": "MyOwn" - }, - "leaseInfo": { - "renewalIntervalInSecs": 30, - "durationInSecs": 90, - "registrationTimestamp": 1457714988223, - "lastRenewalTimestamp": 1457716158319, - "evictionTimestamp": 0, - "serviceUpTimestamp": 1457714988223 - }, - "metadata": { - "@class": "java.util.Collections$EmptyMap" - }, - "homePageUrl": "http://localhost:8080/", - "statusPageUrl": "http://localhost:8080/info", - "healthCheckUrl": "http://localhost:8080/health", - "vipAddress": "foo", - "isCoordinatingDiscoveryServer": "false", - "lastUpdatedTimestamp": "1457714988223", - "lastDirtyTimestamp": "1457714988172", - "actionType": "ADDED" + "instanceId": "localhost:foo" } ] } """; - var result = JsonSerializer.Deserialize(json); + JsonApplication? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonApplication); result.Should().NotBeNull(); result.Name.Should().Be("FOO"); - result.Instances.Should().ContainSingle(); - // Rest is validated by JsonInstanceInfoTest + JsonInstanceInfo? instance = result.Instances.Should().ContainSingle().Subject; + instance.Should().NotBeNull(); + instance.InstanceId.Should().Be("localhost:foo"); + } + + [Fact] + public void Deserialize_InstanceSingleElement() + { + const string json = """ + { + "name": "FOO", + "instance": { + "instanceId": "localhost:foo" + } + } + """; + + JsonApplication? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonApplication); + + result.Should().NotBeNull(); + result.Name.Should().Be("FOO"); + + JsonInstanceInfo? instance = result.Instances.Should().ContainSingle().Subject; + instance.Should().NotBeNull(); + instance.InstanceId.Should().Be("localhost:foo"); } } diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsRootTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsRootTest.cs index fcbd465e8d..5e3c9a94b1 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsRootTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsRootTest.cs @@ -10,69 +10,17 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonApplicationsRootTest { [Fact] - public void Deserialize_GoodJson() + public void Deserialize() { const string json = """ { - "applications": { - "versions__delta": "1", - "apps__hashcode": "UP_1_", - "application": [ - { - "name": "FOO", - "instance": [ - { - "instanceId": "localhost:foo", - "hostName": "localhost", - "app": "FOO", - "ipAddr": "192.168.56.1", - "status": "UP", - "overriddenStatus": "UNKNOWN", - "port": { - "$": 8080, - "@enabled": "true" - }, - "securePort": { - "$": 443, - "@enabled": "false" - }, - "countryId": 1, - "dataCenterInfo": { - "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", - "name": "MyOwn" - }, - "leaseInfo": { - "renewalIntervalInSecs": 30, - "durationInSecs": 90, - "registrationTimestamp": 1457714988223, - "lastRenewalTimestamp": 1457716158319, - "evictionTimestamp": 0, - "serviceUpTimestamp": 1457714988223 - }, - "metadata": { - "@class": "java.util.Collections$EmptyMap" - }, - "homePageUrl": "http://localhost:8080/", - "statusPageUrl": "http://localhost:8080/info", - "healthCheckUrl": "http://localhost:8080/health", - "vipAddress": "foo", - "isCoordinatingDiscoveryServer": "false", - "lastUpdatedTimestamp": "1457714988223", - "lastDirtyTimestamp": "1457714988172", - "actionType": "ADDED" - } - ] - } - ] - } + "applications": {} } """; - var result = JsonSerializer.Deserialize(json); + JsonApplicationsRoot? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonApplicationsRoot); result.Should().NotBeNull(); result.Applications.Should().NotBeNull(); - - // Rest is validated by JsonApplicationsTest } } diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsTest.cs index 60f22290c5..84696bdf91 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonApplicationsTest.cs @@ -10,7 +10,31 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonApplicationsTest { [Fact] - public void Deserialize_GoodJson() + public void Deserialize_ApplicationSingleElement() + { + const string json = """ + { + "versions__delta": "1", + "apps__hashcode": "UP_1_", + "application": { + "name": "FOO" + } + } + """; + + JsonApplications? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonApplications); + + result.Should().NotBeNull(); + result.VersionDelta.Should().Be(1); + result.AppsHashCode.Should().Be("UP_1_"); + + JsonApplication? app = result.Applications.Should().ContainSingle().Subject; + app.Should().NotBeNull(); + app.Name.Should().Be("FOO"); + } + + [Fact] + public void Deserialize_ApplicationArray() { const string json = """ { @@ -18,61 +42,20 @@ public void Deserialize_GoodJson() "apps__hashcode": "UP_1_", "application": [ { - "name": "FOO", - "instance": [ - { - "instanceId": "localhost:foo", - "hostName": "localhost", - "app": "FOO", - "ipAddr": "192.168.56.1", - "status": "UP", - "overriddenStatus": "UNKNOWN", - "port": { - "$": 8080, - "@enabled": "true" - }, - "securePort": { - "$": 443, - "@enabled": "false" - }, - "countryId": 1, - "dataCenterInfo": { - "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", - "name": "MyOwn" - }, - "leaseInfo": { - "renewalIntervalInSecs": 30, - "durationInSecs": 90, - "registrationTimestamp": 1457714988223, - "lastRenewalTimestamp": 1457716158319, - "evictionTimestamp": 0, - "serviceUpTimestamp": 1457714988223 - }, - "metadata": { - "@class": "java.util.Collections$EmptyMap" - }, - "homePageUrl": "http://localhost:8080/", - "statusPageUrl": "http://localhost:8080/info", - "healthCheckUrl": "http://localhost:8080/health", - "vipAddress": "foo", - "isCoordinatingDiscoveryServer": "false", - "lastUpdatedTimestamp": "1457714988223", - "lastDirtyTimestamp": "1457714988172", - "actionType": "ADDED" - } - ] + "name": "FOO" } ] } """; - var result = JsonSerializer.Deserialize(json); + JsonApplications? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonApplications); result.Should().NotBeNull(); - result.AppsHashCode.Should().Be("UP_1_"); result.VersionDelta.Should().Be(1); - result.Applications.Should().ContainSingle(); + result.AppsHashCode.Should().Be("UP_1_"); - // Rest is validated by JsonApplicationTest + JsonApplication? app = result.Applications.Should().ContainSingle().Subject; + app.Should().NotBeNull(); + app.Name.Should().Be("FOO"); } } diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoRootTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoRootTest.cs index 6eb99be928..83903f2149 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoRootTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoRootTest.cs @@ -3,7 +3,7 @@ // See the LICENSE file in the project root for more information. using System.Text.Json; -using Steeltoe.Discovery.Eureka.AppInfo; +using Steeltoe.Common.TestResources; using Steeltoe.Discovery.Eureka.Transport; namespace Steeltoe.Discovery.Eureka.Test.Transport; @@ -11,68 +11,34 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonInstanceInfoRootTest { [Fact] - public void Deserialize_GoodJson() + public void Serialize() + { + var root = new JsonInstanceInfoRoot + { + Instance = new JsonInstanceInfo() + }; + + string result = JsonSerializer.Serialize(root, EurekaJsonSerializerContext.Default.JsonInstanceInfoRoot); + + result.Should().BeJson(""" + { + "instance": {} + } + """); + } + + [Fact] + public void Deserialize() { const string json = """ { - "instance": { - "instanceId": "DESKTOP-GNQ5SUT", - "app": "FOOBAR", - "appGroupName": null, - "ipAddr": "192.168.0.147", - "sid": "na", - "port": { - "@enabled": true, - "$": 80 - }, - "securePort": { - "@enabled": false, - "$": 443 - }, - "homePageUrl": "http://DESKTOP-GNQ5SUT:80/", - "statusPageUrl": "http://DESKTOP-GNQ5SUT:80/Status", - "healthCheckUrl": "http://DESKTOP-GNQ5SUT:80/health-check", - "secureHealthCheckUrl": null, - "vipAddress": "DESKTOP-GNQ5SUT:80", - "secureVipAddress": "DESKTOP-GNQ5SUT:443", - "countryId": 1, - "dataCenterInfo": { - "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", - "name": "MyOwn" - }, - "hostName": "DESKTOP-GNQ5SUT", - "status": "UP", - "overriddenStatus": "UNKNOWN", - "leaseInfo": { - "renewalIntervalInSecs": 30, - "durationInSecs": 90, - "registrationTimestamp": 0, - "lastRenewalTimestamp": 0, - "renewalTimestamp": 0, - "evictionTimestamp": 0, - "serviceUpTimestamp": 0 - }, - "isCoordinatingDiscoveryServer": false, - "metadata": { - "@class": "java.util.Collections$EmptyMap", - "metadata": null - }, - "lastUpdatedTimestamp": 1458116137663, - "lastDirtyTimestamp": 1458116137663, - "actionType": "ADDED", - "asgName": null - } + "instance": {} } """; - var result = JsonSerializer.Deserialize(json); + JsonInstanceInfoRoot? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonInstanceInfoRoot); result.Should().NotBeNull(); result.Instance.Should().NotBeNull(); - - // Random check some values - result.Instance.ActionType.Should().Be(ActionType.Added); - result.Instance.HealthCheckUrl.Should().Be("http://DESKTOP-GNQ5SUT:80/health-check"); - result.Instance.AppName.Should().Be("FOOBAR"); } } diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoTest.cs index eebfffe565..7c842dae07 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonInstanceInfoTest.cs @@ -3,6 +3,7 @@ // See the LICENSE file in the project root for more information. using System.Text.Json; +using Steeltoe.Common.TestResources; using Steeltoe.Discovery.Eureka.AppInfo; using Steeltoe.Discovery.Eureka.Transport; @@ -11,7 +12,105 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonInstanceInfoTest { [Fact] - public void Deserialize_GoodJson() + public void Serialize() + { + var instanceInfo = new JsonInstanceInfo + { + InstanceId = "localhost:foo", + HostName = "localhost", + AppName = "FOO", + IPAddress = "192.168.56.1", + Status = InstanceStatus.Up, + OverriddenStatus = InstanceStatus.OutOfService, + OverriddenStatusLegacy = InstanceStatus.Down, + Port = new JsonPortWrapper + { + Enabled = true, + Port = 8080 + }, + SecurePort = new JsonPortWrapper + { + Enabled = false, + Port = 443 + }, + CountryId = 1, + DataCenterInfo = new JsonDataCenterInfo + { + ClassName = "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", + Name = "MyOwn" + }, + LeaseInfo = new JsonLeaseInfo + { + RenewalIntervalInSeconds = 30, + DurationInSeconds = 90, + RegistrationTimestamp = 1_457_714_988_223, + LastRenewalTimestamp = 1_457_716_158_319, + EvictionTimestamp = 1_457_715_134_123, + ServiceUpTimestamp = 1_457_714_988_223 + }, + Metadata = new Dictionary + { + ["@class"] = "java.util.Collections$EmptyMap" + }, + HomePageUrl = "http://localhost:8080/", + StatusPageUrl = "http://localhost:8080/info", + HealthCheckUrl = "http://localhost:8080/health", + VipAddress = "foo", + IsCoordinatingDiscoveryServer = false, + LastUpdatedTimestamp = 1_457_714_988_223, + LastDirtyTimestamp = 1_457_714_988_172, + ActionType = ActionType.Added + }; + + string result = JsonSerializer.Serialize(instanceInfo, EurekaJsonSerializerContext.Default.JsonInstanceInfo); + + result.Should().BeJson(""" + { + "instanceId": "localhost:foo", + "app": "FOO", + "ipAddr": "192.168.56.1", + "port": { + "@enabled": "true", + "$": 8080 + }, + "securePort": { + "@enabled": "false", + "$": 443 + }, + "homePageUrl": "http://localhost:8080/", + "statusPageUrl": "http://localhost:8080/info", + "healthCheckUrl": "http://localhost:8080/health", + "vipAddress": "foo", + "countryId": 1, + "dataCenterInfo": { + "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo", + "name": "MyOwn" + }, + "hostName": "localhost", + "status": "UP", + "overriddenStatus": "OUT_OF_SERVICE", + "overriddenstatus": "DOWN", + "leaseInfo": { + "renewalIntervalInSecs": 30, + "durationInSecs": 90, + "registrationTimestamp": "1457714988223", + "lastRenewalTimestamp": "1457716158319", + "evictionTimestamp": "1457715134123", + "serviceUpTimestamp": "1457714988223" + }, + "isCoordinatingDiscoveryServer": "false", + "metadata": { + "@class": "java.util.Collections$EmptyMap" + }, + "lastUpdatedTimestamp": "1457714988223", + "lastDirtyTimestamp": "1457714988172", + "actionType": "ADDED" + } + """); + } + + [Fact] + public void Deserialize() { const string json = """ { @@ -40,7 +139,7 @@ public void Deserialize_GoodJson() "durationInSecs": 90, "registrationTimestamp": 1457714988223, "lastRenewalTimestamp": 1457716158319, - "evictionTimestamp": 0, + "evictionTimestamp": 1457715134123, "serviceUpTimestamp": 1457714988223 }, "metadata": { @@ -57,7 +156,7 @@ public void Deserialize_GoodJson() } """; - var result = JsonSerializer.Deserialize(json); + JsonInstanceInfo? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonInstanceInfo); result.Should().NotBeNull(); result.InstanceId.Should().Be("localhost:foo"); @@ -82,7 +181,7 @@ public void Deserialize_GoodJson() result.LeaseInfo.DurationInSeconds.Should().Be(90); result.LeaseInfo.RegistrationTimestamp.Should().Be(1_457_714_988_223); result.LeaseInfo.LastRenewalTimestamp.Should().Be(1_457_716_158_319); - result.LeaseInfo.EvictionTimestamp.Should().Be(0); + result.LeaseInfo.EvictionTimestamp.Should().Be(1_457_715_134_123); result.LeaseInfo.ServiceUpTimestamp.Should().Be(1_457_714_988_223); result.Metadata.Should().ContainSingle(); result.Metadata.Should().ContainKey("@class").WhoseValue.Should().Be("java.util.Collections$EmptyMap"); diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonLeaseTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonLeaseTest.cs index c8366ad635..689312b069 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonLeaseTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonLeaseTest.cs @@ -3,6 +3,7 @@ // See the LICENSE file in the project root for more information. using System.Text.Json; +using Steeltoe.Common.TestResources; using Steeltoe.Discovery.Eureka.Transport; namespace Steeltoe.Discovery.Eureka.Test.Transport; @@ -10,7 +11,34 @@ namespace Steeltoe.Discovery.Eureka.Test.Transport; public sealed class JsonLeaseTest { [Fact] - public void Deserialize_GoodJson() + public void Serialize() + { + var leaseInfo = new JsonLeaseInfo + { + RenewalIntervalInSeconds = 30, + DurationInSeconds = 90, + RegistrationTimestamp = 1_457_714_988_223, + LastRenewalTimestamp = 1_457_716_158_319, + EvictionTimestamp = 1_457_715_134_123, + ServiceUpTimestamp = 1_457_714_988_223 + }; + + string result = JsonSerializer.Serialize(leaseInfo, EurekaJsonSerializerContext.Default.JsonLeaseInfo); + + result.Should().BeJson(""" + { + "renewalIntervalInSecs": 30, + "durationInSecs": 90, + "registrationTimestamp": "1457714988223", + "lastRenewalTimestamp": "1457716158319", + "evictionTimestamp": "1457715134123", + "serviceUpTimestamp": "1457714988223" + } + """); + } + + [Fact] + public void Deserialize() { const string json = """ { @@ -18,19 +46,19 @@ public void Deserialize_GoodJson() "durationInSecs": 90, "registrationTimestamp": 1457714988223, "lastRenewalTimestamp": 1457716158319, - "evictionTimestamp": 0, + "evictionTimestamp": 1457715134123, "serviceUpTimestamp": 1457714988223 } """; - var leaseInfo = JsonSerializer.Deserialize(json); + JsonLeaseInfo? result = JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonLeaseInfo); - leaseInfo.Should().NotBeNull(); - leaseInfo.RenewalIntervalInSeconds.Should().Be(30); - leaseInfo.DurationInSeconds.Should().Be(90); - leaseInfo.RegistrationTimestamp.Should().Be(1_457_714_988_223); - leaseInfo.LastRenewalTimestamp.Should().Be(1_457_716_158_319); - leaseInfo.EvictionTimestamp.Should().Be(0); - leaseInfo.ServiceUpTimestamp.Should().Be(1_457_714_988_223); + result.Should().NotBeNull(); + result.RenewalIntervalInSeconds.Should().Be(30); + result.DurationInSeconds.Should().Be(90); + result.RegistrationTimestamp.Should().Be(1_457_714_988_223); + result.LastRenewalTimestamp.Should().Be(1_457_716_158_319); + result.EvictionTimestamp.Should().Be(1_457_715_134_123); + result.ServiceUpTimestamp.Should().Be(1_457_714_988_223); } } diff --git a/src/Discovery/test/Eureka.Test/Transport/JsonSerializationTest.cs b/src/Discovery/test/Eureka.Test/Transport/JsonSerializationTest.cs index 34bc67c396..ae7d02c9b8 100644 --- a/src/Discovery/test/Eureka.Test/Transport/JsonSerializationTest.cs +++ b/src/Discovery/test/Eureka.Test/Transport/JsonSerializationTest.cs @@ -22,7 +22,7 @@ public void Deserialize_BadJson_Throws() """; #pragma warning restore JSON001 // Invalid JSON pattern - Action action = () => JsonSerializer.Deserialize(json); + Action action = () => JsonSerializer.Deserialize(json, EurekaJsonSerializerContext.Default.JsonInstanceInfo); action.Should().ThrowExactly(); } diff --git a/src/Management/src/Abstractions/Configuration/EndpointPermissions.cs b/src/Management/src/Abstractions/Configuration/EndpointPermissions.cs index ce61c2964e..3e46238110 100644 --- a/src/Management/src/Abstractions/Configuration/EndpointPermissions.cs +++ b/src/Management/src/Abstractions/Configuration/EndpointPermissions.cs @@ -10,7 +10,7 @@ namespace Steeltoe.Management.Configuration; public enum EndpointPermissions { /// - /// Indicates no permission constraints. + /// Indicates no permissions. /// None, diff --git a/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundryJsonSerializerContext.cs b/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundryJsonSerializerContext.cs new file mode 100644 index 0000000000..91b49a4f3c --- /dev/null +++ b/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundryJsonSerializerContext.cs @@ -0,0 +1,12 @@ +// 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.Text.Json.Serialization; + +namespace Steeltoe.Management.Endpoint.Actuators.CloudFoundry; + +[JsonSourceGenerationOptions] +[JsonSerializable(typeof(PermissionsProvider.PermissionsResponse))] +[JsonSerializable(typeof(SecurityResult))] +internal sealed partial class CloudFoundryJsonSerializerContext : JsonSerializerContext; diff --git a/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundrySecurityMiddleware.cs b/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundrySecurityMiddleware.cs index c8734d6ed0..9fedf69e56 100644 --- a/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundrySecurityMiddleware.cs +++ b/src/Management/src/Endpoint/Actuators/CloudFoundry/CloudFoundrySecurityMiddleware.cs @@ -171,7 +171,7 @@ private async Task ReturnErrorAsync(HttpContext context, SecurityResult error) context.Response.StatusCode = (int)error.Code; } - await JsonSerializer.SerializeAsync(context.Response.Body, error, cancellationToken: context.RequestAborted); + await JsonSerializer.SerializeAsync(context.Response.Body, error, CloudFoundryJsonSerializerContext.Default.SecurityResult, context.RequestAborted); } [LoggerMessage(Level = LogLevel.Debug, Message = "Entering Cloud Foundry Security middleware at path {RequestPath}.")] diff --git a/src/Management/src/Endpoint/Actuators/CloudFoundry/PermissionsProvider.cs b/src/Management/src/Endpoint/Actuators/CloudFoundry/PermissionsProvider.cs index c44bfd35e9..ba03042926 100644 --- a/src/Management/src/Endpoint/Actuators/CloudFoundry/PermissionsProvider.cs +++ b/src/Management/src/Endpoint/Actuators/CloudFoundry/PermissionsProvider.cs @@ -4,8 +4,8 @@ using System.Net; using System.Net.Http.Headers; -using System.Security; using System.Text.Json; +using System.Text.Json.Serialization; using Microsoft.AspNetCore.Http; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; @@ -19,7 +19,6 @@ namespace Steeltoe.Management.Endpoint.Actuators.CloudFoundry; internal sealed partial class PermissionsProvider { - private const string ReadSensitiveDataJsonPropertyName = "read_sensitive_data"; public const string HttpClientName = "CloudFoundrySecurity"; private static readonly TimeSpan GetPermissionsTimeout = TimeSpan.FromMilliseconds(5_000); @@ -77,8 +76,11 @@ public async Task GetPermissionsAsync(string accessToken, Cancel : new SecurityResult(HttpStatusCode.ServiceUnavailable, Messages.CloudFoundryNotReachable); } - EndpointPermissions permissions = await ParsePermissionsResponseAsync(response, cancellationToken); - return new SecurityResult(permissions); + EndpointPermissions? permissions = await ParsePermissionsResponseAsync(response, cancellationToken); + + return permissions != null + ? new SecurityResult(permissions.Value) + : new SecurityResult(HttpStatusCode.BadGateway, Messages.CloudFoundryBrokenResponse); } catch (HttpRequestException exception) { @@ -91,34 +93,31 @@ public async Task GetPermissionsAsync(string accessToken, Cancel } } - public async Task ParsePermissionsResponseAsync(HttpResponseMessage response, CancellationToken cancellationToken) + public async Task ParsePermissionsResponseAsync(HttpResponseMessage response, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(response); - string json = string.Empty; - var permissions = EndpointPermissions.None; - try { - json = await response.Content.ReadAsStringAsync(cancellationToken); - + string json = await response.Content.ReadAsStringAsync(cancellationToken); LogResponseJson(SecurityUtilities.SanitizeInput(json)); - var result = JsonSerializer.Deserialize>(json); + PermissionsResponse? result = JsonSerializer.Deserialize(json, CloudFoundryJsonSerializerContext.Default.PermissionsResponse); - if (result != null && result.TryGetValue(ReadSensitiveDataJsonPropertyName, out JsonElement permissionElement)) + EndpointPermissions permissions = result switch { - bool enabled = JsonSerializer.Deserialize(permissionElement.GetRawText()); - permissions = enabled ? EndpointPermissions.Full : EndpointPermissions.Restricted; - } + { ReadBasicData: true, ReadSensitiveData: true } => EndpointPermissions.Full, + { ReadBasicData: true, ReadSensitiveData: false } => EndpointPermissions.Restricted, + _ => EndpointPermissions.None + }; + + LogPermissions(permissions); + return permissions; } catch (Exception exception) when (!exception.IsCancellation()) { - throw new SecurityException($"Exception extracting permissions from json: {SecurityUtilities.SanitizeInput(json)}", exception); + return null; } - - LogPermissions(permissions); - return permissions; } private HttpClient CreateHttpClient() @@ -140,6 +139,15 @@ private HttpClient CreateHttpClient() [LoggerMessage(Level = LogLevel.Debug, Message = "Resolved permissions to {Permissions}.")] private partial void LogPermissions(EndpointPermissions permissions); + internal sealed class PermissionsResponse + { + [JsonPropertyName("read_basic_data")] + public bool ReadBasicData { get; set; } + + [JsonPropertyName("read_sensitive_data")] + public bool ReadSensitiveData { get; set; } + } + internal static class Messages { public const string AccessDenied = "Access denied"; @@ -148,6 +156,7 @@ internal static class Messages public const string CloudFoundryApiMissing = "Cloud controller URL is not available"; public const string CloudFoundryNotReachable = "Cloud controller not reachable"; public const string CloudFoundryTimeout = "Cloud controller request timed out"; + public const string CloudFoundryBrokenResponse = "Failed to parse Cloud controller response"; public const string InvalidToken = "Invalid token"; } } diff --git a/src/Management/src/Endpoint/Actuators/DbMigrations/DbMigrationsDescriptor.cs b/src/Management/src/Endpoint/Actuators/DbMigrations/DbMigrationsDescriptor.cs index 656246f636..17f78cceb1 100644 --- a/src/Management/src/Endpoint/Actuators/DbMigrations/DbMigrationsDescriptor.cs +++ b/src/Management/src/Endpoint/Actuators/DbMigrations/DbMigrationsDescriptor.cs @@ -2,10 +2,15 @@ // 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.Text.Json.Serialization; + namespace Steeltoe.Management.Endpoint.Actuators.DbMigrations; public sealed class DbMigrationsDescriptor { + [JsonPropertyName("pendingMigrations")] public IList PendingMigrations { get; } = new List(); + + [JsonPropertyName("appliedMigrations")] public IList AppliedMigrations { get; } = new List(); } diff --git a/src/Management/src/Endpoint/Actuators/Health/HealthEndpointRequest.cs b/src/Management/src/Endpoint/Actuators/Health/HealthEndpointRequest.cs index fd1fe47c94..dc593685fd 100644 --- a/src/Management/src/Endpoint/Actuators/Health/HealthEndpointRequest.cs +++ b/src/Management/src/Endpoint/Actuators/Health/HealthEndpointRequest.cs @@ -2,11 +2,16 @@ // 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.Text.Json.Serialization; + namespace Steeltoe.Management.Endpoint.Actuators.Health; public sealed class HealthEndpointRequest { + [JsonPropertyName("groupName")] public string GroupName { get; } + + [JsonPropertyName("hasClaim")] public bool HasClaim { get; } public HealthEndpointRequest(string groupName, bool hasClaim) diff --git a/src/Management/src/Endpoint/Actuators/Health/HealthEndpointResponse.cs b/src/Management/src/Endpoint/Actuators/Health/HealthEndpointResponse.cs index 231d84fc53..09e734c9c5 100644 --- a/src/Management/src/Endpoint/Actuators/Health/HealthEndpointResponse.cs +++ b/src/Management/src/Endpoint/Actuators/Health/HealthEndpointResponse.cs @@ -14,17 +14,20 @@ public sealed class HealthEndpointResponse /// /// Gets the status of the health check. /// + [JsonPropertyName("status")] [JsonConverter(typeof(SnakeCaseAllCapsEnumMemberJsonConverter))] public HealthStatus Status { get; init; } /// /// Gets a description of the health check result. /// + [JsonPropertyName("description")] public string? Description { get; init; } /// /// Gets the individual health check components, including their details. /// + [JsonPropertyName("components")] [JsonIgnoreEmptyCollection] public IDictionary Components { get; } = new Dictionary(); @@ -32,6 +35,7 @@ public sealed class HealthEndpointResponse /// Gets the list of available health groups. /// [JsonIgnoreEmptyCollection] + [JsonPropertyName("groups")] public IList Groups { get; } = new List(); /// diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchange.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchange.cs index ef97df0eea..1ca2564a46 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchange.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchange.cs @@ -12,10 +12,19 @@ public sealed class HttpExchange [JsonPropertyName("timeTaken")] public string? SerializedTimeTaken => TimeTaken != null ? XmlConvert.ToString(TimeTaken.Value) : null; + [JsonPropertyName("timestamp")] public DateTime Timestamp { get; } + + [JsonPropertyName("principal")] public HttpExchangePrincipal? Principal { get; } + + [JsonPropertyName("session")] public HttpExchangeSession? Session { get; } + + [JsonPropertyName("request")] public HttpExchangeRequest Request { get; } + + [JsonPropertyName("response")] public HttpExchangeResponse Response { get; } [JsonIgnore] diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangePrincipal.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangePrincipal.cs index 2e7f976c12..f8e870963a 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangePrincipal.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangePrincipal.cs @@ -2,10 +2,13 @@ // 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.Text.Json.Serialization; + namespace Steeltoe.Management.Endpoint.Actuators.HttpExchanges; public sealed class HttpExchangePrincipal { + [JsonPropertyName("name")] public string Name { get; } public HttpExchangePrincipal(string name) diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeRequest.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeRequest.cs index ddce7c1e83..2f8d0bc53a 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeRequest.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeRequest.cs @@ -2,6 +2,7 @@ // 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.Text.Json.Serialization; using Microsoft.Extensions.Primitives; using Steeltoe.Common.Json; @@ -9,12 +10,17 @@ namespace Steeltoe.Management.Endpoint.Actuators.HttpExchanges; public sealed class HttpExchangeRequest { + [JsonPropertyName("method")] public string Method { get; } + + [JsonPropertyName("uri")] public Uri Uri { get; } + [JsonPropertyName("headers")] [JsonIgnoreEmptyCollection] public IDictionary Headers { get; } + [JsonPropertyName("remoteAddress")] public string? RemoteAddress { get; } public HttpExchangeRequest(string method, Uri uri, IDictionary headers, string? remoteAddress) diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeResponse.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeResponse.cs index 63e6338a98..4ecf185834 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeResponse.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeResponse.cs @@ -2,6 +2,7 @@ // 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.Text.Json.Serialization; using Microsoft.Extensions.Primitives; using Steeltoe.Common.Json; @@ -9,8 +10,10 @@ namespace Steeltoe.Management.Endpoint.Actuators.HttpExchanges; public sealed class HttpExchangeResponse { + [JsonPropertyName("status")] public int Status { get; } + [JsonPropertyName("headers")] [JsonIgnoreEmptyCollection] public IDictionary Headers { get; } diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeSession.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeSession.cs index 33ed0af39c..b2ad567174 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeSession.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangeSession.cs @@ -2,10 +2,13 @@ // 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.Text.Json.Serialization; + namespace Steeltoe.Management.Endpoint.Actuators.HttpExchanges; public sealed class HttpExchangeSession { + [JsonPropertyName("id")] public string Id { get; } public HttpExchangeSession(string id) diff --git a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangesResult.cs b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangesResult.cs index d687f08313..32bc9a2505 100644 --- a/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangesResult.cs +++ b/src/Management/src/Endpoint/Actuators/HttpExchanges/HttpExchangesResult.cs @@ -2,12 +2,14 @@ // 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.Text.Json.Serialization; using Steeltoe.Common; namespace Steeltoe.Management.Endpoint.Actuators.HttpExchanges; public sealed class HttpExchangesResult { + [JsonPropertyName("exchanges")] public IList Exchanges { get; } public HttpExchangesResult(IList exchanges) diff --git a/src/Management/src/Endpoint/Actuators/Hypermedia/Link.cs b/src/Management/src/Endpoint/Actuators/Hypermedia/Link.cs index a6cb952bbe..05fb09a975 100644 --- a/src/Management/src/Endpoint/Actuators/Hypermedia/Link.cs +++ b/src/Management/src/Endpoint/Actuators/Hypermedia/Link.cs @@ -8,6 +8,7 @@ namespace Steeltoe.Management.Endpoint.Actuators.Hypermedia; public sealed class Link { + [JsonPropertyName("href")] public string Href { get; set; } [JsonPropertyName("templated")] diff --git a/src/Management/src/Endpoint/Actuators/Hypermedia/Links.cs b/src/Management/src/Endpoint/Actuators/Hypermedia/Links.cs index 6a748f1c6c..777f7f5e93 100644 --- a/src/Management/src/Endpoint/Actuators/Hypermedia/Links.cs +++ b/src/Management/src/Endpoint/Actuators/Hypermedia/Links.cs @@ -14,6 +14,7 @@ public sealed class Links /// /// Gets or sets the type of links contained in this collection. /// + [JsonPropertyName("type")] public string Type { get; set; } = "steeltoe"; /// diff --git a/src/Management/src/Endpoint/Actuators/Loggers/LoggersEndpointMiddleware.cs b/src/Management/src/Endpoint/Actuators/Loggers/LoggersEndpointMiddleware.cs index 30427ca776..aa8b9fc352 100644 --- a/src/Management/src/Endpoint/Actuators/Loggers/LoggersEndpointMiddleware.cs +++ b/src/Management/src/Endpoint/Actuators/Loggers/LoggersEndpointMiddleware.cs @@ -31,11 +31,12 @@ internal sealed partial class LoggersEndpointMiddleware( if (httpContext.Request.Path.StartsWithSegments(path, out PathString remaining) && remaining.HasValue) { - string loggerName = remaining.Value!.TrimStart('/'); + string loggerName = remaining.Value.TrimStart('/'); - Dictionary change = await DeserializeRequestAsync(httpContext.Request.Body, cancellationToken); + Dictionary changes = await DeserializeRequestAsync(httpContext.Request.Body, cancellationToken); - change.TryGetValue("configuredLevel", out string? level); + // Spring Boot Admin sends {} to reset the level, while Apps Manager sends {"configuredLevel":null} + _ = changes.TryGetValue("configuredLevel", out string? level); LogChangeRequest(loggerName, level ?? "RESET"); @@ -55,11 +56,12 @@ internal sealed partial class LoggersEndpointMiddleware( return new LoggersRequest(); } - private async Task> DeserializeRequestAsync(Stream stream, CancellationToken cancellationToken) + private async Task> DeserializeRequestAsync(Stream stream, CancellationToken cancellationToken) { try { - var dictionary = await JsonSerializer.DeserializeAsync>(stream, cancellationToken: cancellationToken); + JsonSerializerOptions options = ManagementOptionsMonitor.CurrentValue.SerializerOptions; + var dictionary = await JsonSerializer.DeserializeAsync>(stream, options, cancellationToken); if (dictionary != null) { diff --git a/src/Management/src/Endpoint/ManagementPort/ManagementPortMiddleware.cs b/src/Management/src/Endpoint/ManagementPort/ManagementPortMiddleware.cs index 6ba88fb103..cd94e77298 100644 --- a/src/Management/src/Endpoint/ManagementPort/ManagementPortMiddleware.cs +++ b/src/Management/src/Endpoint/ManagementPort/ManagementPortMiddleware.cs @@ -74,7 +74,7 @@ private bool HasMappedInstancePort(int managementPort, int? requestPort) if (!string.IsNullOrEmpty(instancePorts)) { - var portMappings = JsonSerializer.Deserialize>(instancePorts); + List? portMappings = JsonSerializer.Deserialize(instancePorts, PortMappingJsonSerializerContext.Default.ListPortMapping); PortMapping? portMapping = portMappings?.Find(mapping => mapping.Internal == managementPort && (requestPort == mapping.ExternalTlsProxy || requestPort == mapping.InternalTlsProxy)); @@ -116,7 +116,7 @@ private void SetResponseError(HttpContext context, int managementPort) Message = "Access to {Path} on port {Port} denied because 'Management:Endpoints:Port' is set to {ManagementPort}.")] private partial void LogAccessDenied(PathString path, int? port, int managementPort); - private sealed record PortMapping + internal sealed record PortMapping { [JsonPropertyName("internal")] public int? Internal { get; init; } diff --git a/src/Discovery/src/Eureka/Transport/JsonApplicationRoot.cs b/src/Management/src/Endpoint/ManagementPort/PortMappingJsonSerializerContext.cs similarity index 50% rename from src/Discovery/src/Eureka/Transport/JsonApplicationRoot.cs rename to src/Management/src/Endpoint/ManagementPort/PortMappingJsonSerializerContext.cs index 5957fa4a22..1e59b524ed 100644 --- a/src/Discovery/src/Eureka/Transport/JsonApplicationRoot.cs +++ b/src/Management/src/Endpoint/ManagementPort/PortMappingJsonSerializerContext.cs @@ -4,10 +4,8 @@ using System.Text.Json.Serialization; -namespace Steeltoe.Discovery.Eureka.Transport; +namespace Steeltoe.Management.Endpoint.ManagementPort; -internal sealed class JsonApplicationRoot -{ - [JsonPropertyName("application")] - public JsonApplication? Application { get; set; } -} +[JsonSourceGenerationOptions] +[JsonSerializable(typeof(List))] +internal sealed partial class PortMappingJsonSerializerContext : JsonSerializerContext; diff --git a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudControllerPermissionsMock.cs b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudControllerPermissionsMock.cs index 5d581d2d1b..3c7a6e22de 100644 --- a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudControllerPermissionsMock.cs +++ b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudControllerPermissionsMock.cs @@ -32,11 +32,17 @@ internal static DelegateToMockHttpClientHandler GetHttpMessageHandler() httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/exception/permissions") .Throw(new HttpRequestException(HttpRequestError.NameResolutionError)); - httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/no_sensitive_data/permissions").Respond(HttpStatusCode.OK, + httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/broken-response/permissions") + .Respond(HttpStatusCode.OK, "application/json", "{"); + + httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/no-permissions/permissions").Respond(HttpStatusCode.OK, "application/json", + """{"read_sensitive_data": false, "read_basic_data": false}"""); + + httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/restricted-permissions/permissions").Respond(HttpStatusCode.OK, "application/json", """{"read_sensitive_data": false, "read_basic_data": true}"""); - httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/success/permissions").Respond(HttpStatusCode.OK, "application/json", - """{"read_sensitive_data": true, "read_basic_data": true}"""); + httpClientHandler.Mock.When(HttpMethod.Get, "https://example.api.com/v2/apps/full-permissions/permissions").Respond(HttpStatusCode.OK, + "application/json", """{"read_sensitive_data": true, "read_basic_data": true}"""); return httpClientHandler; } diff --git a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundryActuatorTest.cs b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundryActuatorTest.cs index 5484052d8a..14f42128c6 100644 --- a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundryActuatorTest.cs +++ b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundryActuatorTest.cs @@ -27,7 +27,7 @@ public sealed class CloudFoundryActuatorTest private const string VcapApplicationForMock = """ { "cf_api": "https://example.api.com", - "application_id": "success" + "application_id": "full-permissions" } """; diff --git a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTest.cs b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTest.cs index 99a64e2782..18e350eb83 100644 --- a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTest.cs +++ b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTest.cs @@ -327,7 +327,7 @@ public async Task RedactsHttpHeaders() { var appSettings = new Dictionary { - ["vcap:application:application_id"] = "success", + ["vcap:application:application_id"] = "full-permissions", ["vcap:application:cf_api"] = "https://example.api.com" }; @@ -379,26 +379,26 @@ public async Task Returns_expected_response_on_permission_check(string scenario, await host.StartAsync(TestContext.Current.CancellationToken); using var client = new HttpClient(); - var testAuthenticationRequestMessage = new HttpRequestMessage(HttpMethod.Get, new Uri("http://localhost:5000/cloudfoundryapplication")); - testAuthenticationRequestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", MockAccessToken); - var testAuthorizationRequestMessage = new HttpRequestMessage(HttpMethod.Get, new Uri("http://localhost:5000/cloudfoundryapplication/info")); - testAuthorizationRequestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", MockAccessToken); + var authenticationRequest = new HttpRequestMessage(HttpMethod.Get, new Uri("http://localhost:5000/cloudfoundryapplication")); + authenticationRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", MockAccessToken); + var authorizationRequest = new HttpRequestMessage(HttpMethod.Get, new Uri("http://localhost:5000/cloudfoundryapplication/info")); + authorizationRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", MockAccessToken); - HttpResponseMessage response = await client.SendAsync(testAuthenticationRequestMessage, TestContext.Current.CancellationToken); - response.StatusCode.Should().Be(steeltoeStatusCode); + HttpResponseMessage authenticationResponse = await client.SendAsync(authenticationRequest, TestContext.Current.CancellationToken); + authenticationResponse.StatusCode.Should().Be(steeltoeStatusCode); if (errorMessage != null) { string jsonErrorValue = JsonValue.Create(errorMessage).ToJsonString(); - string errorText = await response.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); + string errorText = await authenticationResponse.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); errorText.Should().Be(steeltoeStatusCode == HttpStatusCode.InternalServerError ? errorMessage : $$"""{"security_error":{{jsonErrorValue}}}"""); } else { - string responseBody = await response.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); + string authenticationResponseBody = await authenticationResponse.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); - responseBody.Should().BeJson(""" + authenticationResponseBody.Should().BeJson(""" { "type":"steeltoe", "_links":{ @@ -415,8 +415,8 @@ public async Task Returns_expected_response_on_permission_check(string scenario, """); } - HttpResponseMessage fullPermissionResponse = await client.SendAsync(testAuthorizationRequestMessage, TestContext.Current.CancellationToken); - fullPermissionResponse.StatusCode.Should().Be(scenario == "no_sensitive_data" ? HttpStatusCode.Forbidden : steeltoeStatusCode); + HttpResponseMessage authorizationResponse = await client.SendAsync(authorizationRequest, TestContext.Current.CancellationToken); + authorizationResponse.StatusCode.Should().Be(scenario == "restricted-permissions" ? HttpStatusCode.Forbidden : steeltoeStatusCode); string logLines = loggerProvider.GetAsText(); logLines.Should().ContainAll(expectedLogs); diff --git a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTestScenarios.cs b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTestScenarios.cs index 7b7419395a..4ab86ca1be 100644 --- a/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTestScenarios.cs +++ b/src/Management/test/Endpoint.Test/Actuators/CloudFoundry/CloudFoundrySecurityMiddlewareTestScenarios.cs @@ -10,8 +10,8 @@ namespace Steeltoe.Management.Endpoint.Test.Actuators.CloudFoundry; internal sealed class CloudFoundrySecurityMiddlewareTestScenarios : TheoryData { - private const string SuccessLog = - "INFO System.Net.Http.HttpClient.CloudFoundrySecurity.ClientHandler: Sending HTTP request GET https://example.api.com/v2/apps/success/permissions"; + private const string FullPermissionsLog = + "INFO System.Net.Http.HttpClient.CloudFoundrySecurity.ClientHandler: Sending HTTP request GET https://example.api.com/v2/apps/full-permissions/permissions"; private static readonly string PermissionsCheckForbiddenLog = $"INFO {typeof(PermissionsProvider)}: Cloud Foundry returned status Forbidden while obtaining permissions from https://example.api.com/v2/apps/forbidden/permissions."; @@ -25,6 +25,9 @@ internal sealed class CloudFoundrySecurityMiddlewareTestScenarios : TheoryData @@ -87,10 +91,10 @@ public async Task Returns_expected_response_on_permission_check(string scenario, switch (scenario) { - case "success": + case "full-permissions": result.Permissions.Should().Be(EndpointPermissions.Full); break; - case "no_sensitive_data": + case "restricted-permissions": result.Permissions.Should().Be(EndpointPermissions.Restricted); break; default: diff --git a/src/Management/test/Endpoint.Test/Actuators/Health/TestContributors/ComplexDetailsContributor.cs b/src/Management/test/Endpoint.Test/Actuators/Health/TestContributors/ComplexDetailsContributor.cs index b23a8cd54c..b3bffabe72 100644 --- a/src/Management/test/Endpoint.Test/Actuators/Health/TestContributors/ComplexDetailsContributor.cs +++ b/src/Management/test/Endpoint.Test/Actuators/Health/TestContributors/ComplexDetailsContributor.cs @@ -2,6 +2,7 @@ // 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.Text.Json.Serialization; using Steeltoe.Common.HealthChecks; namespace Steeltoe.Management.Endpoint.Test.Actuators.Health.TestContributors; @@ -38,12 +39,22 @@ internal sealed class ComplexDetailsContributor : IHealthContributor private sealed class TestHealthDetails { + [JsonPropertyName("testString")] public string TestString { get; set; } = "test-string"; + + [JsonPropertyName("testInteger")] public int TestInteger { get; set; } = 123; + + [JsonPropertyName("testFloatingPoint")] public double TestFloatingPoint { get; set; } = 1.23; + + [JsonPropertyName("testBoolean")] public bool TestBoolean { get; set; } = true; + + [JsonPropertyName("nestedComplexType")] public TestHealthDetails? NestedComplexType { get; set; } + [JsonPropertyName("testList")] public List TestList { get; set; } = [ "A", @@ -51,6 +62,7 @@ private sealed class TestHealthDetails "C" ]; + [JsonPropertyName("testDictionary")] public Dictionary TestDictionary { get; set; } = new() { ["One"] = 1, diff --git a/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorSerilogTest.cs b/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorSerilogTest.cs index 02ccd12aca..70e96e837a 100644 --- a/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorSerilogTest.cs +++ b/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorSerilogTest.cs @@ -214,11 +214,8 @@ public async Task Can_change_minimum_levels_with_serilog() } """); - HttpResponseMessage resetResponse = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake.Category"), new StringContent(""" - { - "configuredLevel": null - } - """, RequestContentType), TestContext.Current.CancellationToken); + HttpResponseMessage resetResponse = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake.Category"), + new StringContent("{}", RequestContentType), TestContext.Current.CancellationToken); resetResponse.StatusCode.Should().Be(HttpStatusCode.NoContent); (await resetResponse.Content.ReadAsStringAsync(TestContext.Current.CancellationToken)).Should().BeEmpty(); diff --git a/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorTest.cs b/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorTest.cs index c5d72935cb..bde4c60857 100644 --- a/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorTest.cs +++ b/src/Management/test/Endpoint.Test/Actuators/Loggers/LoggersActuatorTest.cs @@ -289,11 +289,8 @@ public async Task Can_change_minimum_levels() } """); - HttpResponseMessage resetResponse = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake.Category"), new StringContent(""" - { - "configuredLevel": null - } - """, RequestContentType), TestContext.Current.CancellationToken); + HttpResponseMessage resetResponse = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake.Category"), + new StringContent("{}", RequestContentType), TestContext.Current.CancellationToken); resetResponse.StatusCode.Should().Be(HttpStatusCode.NoContent); (await resetResponse.Content.ReadAsStringAsync(TestContext.Current.CancellationToken)).Should().BeEmpty(); @@ -345,6 +342,112 @@ public async Task Can_change_minimum_levels() """); } + [Fact] + public async Task Can_reset_minimum_level_by_sending_configuredLevel_null() + { + var appSettings = new Dictionary(AppSettings) + { + ["Logging:LogLevel:Default"] = "Error", + ["Logging:LogLevel:Fake"] = "Debug" + }; + + WebApplicationBuilder builder = TestWebApplicationBuilderFactory.Create(); + builder.Configuration.AddInMemoryCollection(appSettings); + EnsureLoggingConfigurationIsBound(builder.Logging, builder.Configuration); + builder.Services.AddSingleton(); + builder.Services.AddLoggersActuator(); + await using WebApplication host = builder.Build(); + + using var loggerFactory = host.Services.GetRequiredService(); + _ = loggerFactory.CreateLogger("Fake.Some"); + + await host.StartAsync(TestContext.Current.CancellationToken); + using HttpClient httpClient = host.GetTestClient(); + + HttpResponseMessage setResponse1 = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake"), new StringContent(""" + { + "configuredLevel": "TRACE" + } + """, RequestContentType), TestContext.Current.CancellationToken); + + setResponse1.StatusCode.Should().Be(HttpStatusCode.NoContent); + (await setResponse1.Content.ReadAsStringAsync(TestContext.Current.CancellationToken)).Should().BeEmpty(); + + HttpResponseMessage getResponse1 = await httpClient.GetAsync(new Uri("http://localhost/actuator/loggers"), TestContext.Current.CancellationToken); + + getResponse1.StatusCode.Should().Be(HttpStatusCode.OK); + + string getResponseBody1 = await getResponse1.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); + + getResponseBody1.Should().BeJson(""" + { + "levels": [ + "OFF", + "FATAL", + "ERROR", + "WARN", + "INFO", + "DEBUG", + "TRACE" + ], + "loggers": { + "Default": { + "effectiveLevel": "ERROR" + }, + "Fake": { + "configuredLevel": "DEBUG", + "effectiveLevel": "TRACE" + }, + "Fake.Some": { + "effectiveLevel": "TRACE" + } + }, + "groups": {} + } + """); + + HttpResponseMessage resetResponse = await httpClient.PostAsync(new Uri("http://localhost/actuator/loggers/Fake"), new StringContent(""" + { + "configuredLevel": null + } + """, RequestContentType), TestContext.Current.CancellationToken); + + resetResponse.StatusCode.Should().Be(HttpStatusCode.NoContent); + (await resetResponse.Content.ReadAsStringAsync(TestContext.Current.CancellationToken)).Should().BeEmpty(); + + HttpResponseMessage getResponse2 = await httpClient.GetAsync(new Uri("http://localhost/actuator/loggers"), TestContext.Current.CancellationToken); + + getResponse2.StatusCode.Should().Be(HttpStatusCode.OK); + + string getResponseBody2 = await getResponse2.Content.ReadAsStringAsync(TestContext.Current.CancellationToken); + + getResponseBody2.Should().BeJson(""" + { + "levels": [ + "OFF", + "FATAL", + "ERROR", + "WARN", + "INFO", + "DEBUG", + "TRACE" + ], + "loggers": { + "Default": { + "effectiveLevel": "ERROR" + }, + "Fake": { + "effectiveLevel": "DEBUG" + }, + "Fake.Some": { + "effectiveLevel": "DEBUG" + } + }, + "groups": {} + } + """); + } + [Fact] public async Task Fails_on_invalid_request_body() { diff --git a/src/Management/test/Endpoint.Test/ContentNegotiationTest.cs b/src/Management/test/Endpoint.Test/ContentNegotiationTest.cs index e3647e9e31..a9f20d2358 100644 --- a/src/Management/test/Endpoint.Test/ContentNegotiationTest.cs +++ b/src/Management/test/Endpoint.Test/ContentNegotiationTest.cs @@ -34,6 +34,7 @@ public async Task Can_use_content_type_with_alternate_casing() using HttpClient client = host.GetTestClient(); MediaTypeHeaderValue contentType = MediaTypeHeaderValue.Parse("APPLICATION/vnd.Spring-Boot.Actuator.v3+JSON"); + HttpContent requestContent = new StringContent("{}", contentType); HttpResponseMessage response = @@ -54,6 +55,7 @@ public async Task Can_use_content_type_including_charset() using HttpClient client = host.GetTestClient(); MediaTypeHeaderValue contentType = MediaTypeHeaderValue.Parse("application/vnd.spring-boot.actuator.v3+json; charset=utf-8"); + HttpContent requestContent = new StringContent("{}", contentType); HttpResponseMessage response = @@ -74,6 +76,7 @@ public async Task Cannot_use_invalid_content_type() using HttpClient client = host.GetTestClient(); MediaTypeHeaderValue contentType = MediaTypeHeaderValue.Parse("application/xhtml+xml"); + HttpContent requestContent = new StringContent("{}", contentType); HttpResponseMessage response = diff --git a/src/Management/test/Endpoint.Test/CorsPolicyTest.cs b/src/Management/test/Endpoint.Test/CorsPolicyTest.cs index 88ef4cef2c..c1ff824cd8 100644 --- a/src/Management/test/Endpoint.Test/CorsPolicyTest.cs +++ b/src/Management/test/Endpoint.Test/CorsPolicyTest.cs @@ -183,6 +183,7 @@ public async Task ConfiguresDefaultActuatorsCorsPolicyForGetRequestOnCloudFoundr mock.Expect(HttpMethod.Get, "https://api.cloud.com/v2/apps/798c2495-fe75-49b1-88da-b81197f2bf06/permissions") .WithHeaders("Authorization", $"bearer {token}").Respond("application/json", """ { + "read_basic_data": true, "read_sensitive_data": true } """);