Fix Loggers, Metrics and Hypermedia when Manangement:Endpoint:Path is…

… set to / (#470)
SteeltoeOSS · Oct 16, 2020 · 0f5750c · 0f5750c
1 parent 39abe43
commit 0f5750c
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 3 deletions.
diff --git a/src/Management/src/EndpointBase/Hypermedia/HypermediaService.cs b/src/Management/src/EndpointBase/Hypermedia/HypermediaService.cs
@@ -49,7 +49,8 @@ public Links Invoke(string baseUrl)
                 {
                     if (!string.IsNullOrEmpty(opt.Id) && !links._links.ContainsKey(opt.Id))
                     {
-                        links._links.Add(opt.Id, new Link(baseUrl + "/" + opt.Path));
+                        var linkPath = $"{baseUrl.TrimEnd('/')}/{opt.Path}";
+                        links._links.Add(opt.Id, new Link(linkPath));
                     }
                     else if (links._links.ContainsKey(opt.Id))
                     {

diff --git a/src/Management/src/EndpointCore/Loggers/LoggersEndpointMiddleware.cs b/src/Management/src/EndpointCore/Loggers/LoggersEndpointMiddleware.cs
@@ -60,7 +60,7 @@ protected internal async Task HandleLoggersRequestAsync(HttpContext context)
                 }
                 else
                 {
-                    paths.AddRange(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Path}"));
+                    paths.AddRange(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Path}".Replace("//", "/")));
                 }
 
                 foreach (var path in paths)

diff --git a/src/Management/src/EndpointCore/Metrics/MetricsEndpointMiddleware.cs b/src/Management/src/EndpointCore/Metrics/MetricsEndpointMiddleware.cs
@@ -93,7 +93,7 @@ protected internal string GetMetricName(HttpRequest request)
                 return GetMetricName(request, _endpoint.Path);
             }
 
-            var paths = new List<string>(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Id}"));
+            var paths = new List<string>(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Id}".Replace("//", "/")));
             foreach (var path in paths)
             {
                 var metricName = GetMetricName(request, path);

diff --git a/src/Management/test/EndpointCore.Test/Hypermedia/EndpointMiddlewareTest.cs b/src/Management/test/EndpointCore.Test/Hypermedia/EndpointMiddlewareTest.cs
@@ -92,6 +92,28 @@ public async void HypermediaEndpointMiddleware_ServiceContractNotBroken()
             Assert.Equal("{\"type\":\"steeltoe\",\"_links\":{\"info\":{\"href\":\"http://localhost/actuator/info\",\"templated\":false},\"self\":{\"href\":\"http://localhost/actuator\",\"templated\":false}}}", json);
         }
 
+        [Fact]
+        public async void HypermediaEndpointMiddleware_Returns_Expected_When_ManagementPath_Is_Slash()
+        {
+            var settings = new Dictionary<string, string>(appSettings);
+            appSettings.Add("Management:Endpoints:Path", "/");
+
+            // arrange a server and client
+            var builder = new WebHostBuilder()
+                .UseStartup<Startup>()
+                .ConfigureAppConfiguration((builderContext, config) => config.AddInMemoryCollection(appSettings));
+
+            using var server = new TestServer(builder);
+            var client = server.CreateClient();
+
+            // send the request
+            var result = await client.GetAsync("http://localhost/");
+            var json = await result.Content.ReadAsStringAsync();
+
+            // assert
+            Assert.Equal("{\"type\":\"steeltoe\",\"_links\":{\"info\":{\"href\":\"http://localhost/info\",\"templated\":false},\"self\":{\"href\":\"http://localhost/\",\"templated\":false}}}", json);
+        }
+
         [Fact]
         public void ActuatorHypermediaEndpointMiddleware_PathAndVerbMatching_ReturnsExpected()
         {

diff --git a/src/Management/test/EndpointCore.Test/Loggers/EndpointMiddlewareTest.cs b/src/Management/test/EndpointCore.Test/Loggers/EndpointMiddlewareTest.cs
@@ -103,6 +103,34 @@ public async void LoggersActuator_AcceptsPost()
             Assert.Equal("ERROR", parsedObject.loggers.Default.effectiveLevel.ToString());
         }
 
+        [Fact]
+        public async void LoggersActuator_AcceptsPost_When_ManagementPath_Is_Slash()
+        {
+            var appSettings = new Dictionary<string, string>(AppSettings);
+            appSettings["management:endpoints:path"] = "/";
+            appSettings.Add("Management:Endpoints:Actuator:Exposure:Include:0", "*");
+
+            var builder = new WebHostBuilder()
+               .UseStartup<Startup>()
+               .ConfigureAppConfiguration((builderContext, config) => config.AddInMemoryCollection(appSettings))
+               .ConfigureLogging((context, loggingBuilder) =>
+               {
+                   loggingBuilder.AddConfiguration(context.Configuration.GetSection("Logging"));
+                   loggingBuilder.AddDynamicConsole();
+               });
+
+            using var server = new TestServer(builder);
+            var client = server.CreateClient();
+            HttpContent content = new StringContent("{\"configuredLevel\":\"ERROR\"}");
+            var changeResult = await client.PostAsync("http://localhost/loggers/Default", content);
+            Assert.Equal(HttpStatusCode.OK, changeResult.StatusCode);
+
+            var validationResult = await client.GetAsync("http://localhost/loggers");
+            var json = await validationResult.Content.ReadAsStringAsync();
+            dynamic parsedObject = JsonConvert.DeserializeObject(json);
+            Assert.Equal("ERROR", parsedObject.loggers.Default.effectiveLevel.ToString());
+        }
+
         [Fact]
         public async void LoggersActuator_UpdateNameSpace_UpdatesChildren()
         {

diff --git a/src/Management/test/EndpointCore.Test/Metrics/MetricsEndpointMiddlewareTest.cs b/src/Management/test/EndpointCore.Test/Metrics/MetricsEndpointMiddlewareTest.cs
@@ -8,10 +8,12 @@
 using OpenCensus.Stats.Measures;
 using OpenCensus.Tags;
 using Steeltoe.Management.Census.Stats;
+using Steeltoe.Management.Endpoint.Hypermedia;
 using Steeltoe.Management.Endpoint.Test;
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using Xunit;
 
 namespace Steeltoe.Management.Endpoint.Metrics.Test
@@ -88,6 +90,30 @@ public void GetMetricName_ReturnsExpected()
             Assert.Null(middle.GetMetricName(context3.Request));
         }
 
+        [Fact]
+        public void GetMetricName_ReturnsExpected_When_ManagementPath_Is_Slash()
+        {
+            var opts = new MetricsEndpointOptions();
+
+            var mopts = TestHelper.GetManagementOptions(opts);
+            var stats = new OpenCensusStats();
+
+            var amOpts = mopts.Where(m => m.GetType() == typeof(ActuatorManagementOptions)).FirstOrDefault() as ActuatorManagementOptions;
+            amOpts.Path = "/";
+
+            var ep = new MetricsEndpoint(opts, stats);
+            var middle = new MetricsEndpointMiddleware(null, ep, mopts);
+
+            var context1 = CreateRequest("GET", "/metrics");
+            Assert.Null(middle.GetMetricName(context1.Request));
+
+            var context2 = CreateRequest("GET", "/metrics/Foo.Bar.Class");
+            Assert.Equal("Foo.Bar.Class", middle.GetMetricName(context2.Request));
+
+            var context3 = CreateRequest("GET", "/metrics", "?tag=key:value&tag=key1:value1");
+            Assert.Null(middle.GetMetricName(context3.Request));
+        }
+
         [Fact]
         public async void HandleMetricsRequestAsync_GetMetricsNames_ReturnsExpected()
         {
-Original file line number
+Diff line change
@@ Expand Up @@
                     }
                     else
                     {
-                        paths.AddRange(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Path}"));
+                        paths.AddRange(_mgmtOptions.Select(opt => $"{opt.Path}/{_endpoint.Path}".Replace("//", "/")));
                     }
                     foreach (var path in paths)
@@ Expand Down @@