// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using Aspire.Dashboard.Components.Layout;
using Aspire.Dashboard.Components.Pages;
using Aspire.Dashboard.Model;
using Aspire.Dashboard.Utils;
using Xunit;
using NavSection = Aspire.Dashboard.Components.Layout.DesktopNavMenu.NavSection;
using ResourceTab = Aspire.Dashboard.Components.Layout.ResourceTab;
using ResourcesPage = Aspire.Dashboard.Components.Pages.Resources;
namespace Aspire.Dashboard.Components.Tests.Layout;
public class ResourcesNavigationTests
{
[Theory]
[InlineData("", nameof(NavSection.Resources))]
[InlineData("?resource=frontend", nameof(NavSection.Resources))]
[InlineData("resources", nameof(NavSection.Resources))]
[InlineData("resources/frontend", nameof(NavSection.Resources))]
[InlineData("consolelogs/resource/frontend", nameof(NavSection.Resources))]
[InlineData("consolelogs", nameof(NavSection.Resources))]
[InlineData("consolelogs?pane=resources#logs", nameof(NavSection.Resources))]
[InlineData("consolelogs?resource=api&resource=worker", nameof(NavSection.Resources))]
[InlineData("consolelogs?pane=telemetry", nameof(NavSection.Telemetry))]
[InlineData("structuredlogs?logLevel=error", nameof(NavSection.Resources))]
[InlineData("traces/detail/abc", nameof(NavSection.Resources))]
[InlineData("metrics/resource/frontend", nameof(NavSection.Resources))]
[InlineData("parameters", nameof(NavSection.Parameters))]
[InlineData("graph#node", nameof(NavSection.Graph))]
[InlineData("terminals", nameof(NavSection.Terminals))]
[InlineData("terminals/resource/shell", nameof(NavSection.Resources))]
[InlineData("extensions", nameof(NavSection.Extensions))]
[InlineData("login", nameof(NavSection.None))]
public void GetSection_WithResourceService(string path, string expectedSection)
{
Assert.Equal(Enum.Parse<NavSection>(expectedSection), DesktopNavMenu.GetSection(path, hasResourceService: true));
}
[Theory]
[InlineData("", nameof(NavSection.None))]
[InlineData("resources/frontend", nameof(NavSection.None))]
[InlineData("terminals", nameof(NavSection.None))]
[InlineData("structuredlogs", nameof(NavSection.Telemetry))]
[InlineData("traces/detail/abc", nameof(NavSection.Telemetry))]
[InlineData("metrics?meter=m", nameof(NavSection.Telemetry))]
public void GetSection_WithoutResourceService(string path, string expectedSection)
{
Assert.Equal(Enum.Parse<NavSection>(expectedSection), DesktopNavMenu.GetSection(path, hasResourceService: false));
}
[Theory]
[InlineData("resources?pane=tags", ResourcePaneMode.Tags)]
[InlineData("resources?pane=TAGS", ResourcePaneMode.Tags)]
[InlineData("structuredlogs?pane=telemetry", ResourcePaneMode.Telemetry)]
[InlineData("resources?resource=api&pane=resources", ResourcePaneMode.Resources)]
[InlineData("consolelogs/resource/api?pane=tags#end", ResourcePaneMode.Tags)]
[InlineData("resources", null)]
[InlineData("resources?resource=api", null)]
[InlineData("resources?pane=unknown", null)]
public void ParsePaneMode_ReturnsModeFromQuery(string path, ResourcePaneMode? expectedMode)
{
Assert.Equal(expectedMode, ResourcesLayout.ParsePaneMode(path));
}
[Theory]
[InlineData(true)]
[InlineData(false)]
public void TelemetryUrls_SelectDedicatedSection(bool hasResourceService)
{
Assert.Equal(NavSection.Telemetry, DesktopNavMenu.GetSection(DashboardUrls.TelemetrySourcesUrl().TrimStart('/'), hasResourceService));
Assert.Equal(NavSection.Telemetry, DesktopNavMenu.GetSection("traces/detail/abc?pane=telemetry", hasResourceService));
Assert.Equal("/structuredlogs?pane=telemetry", DashboardUrls.TelemetrySourcesUrl());
}
[Theory]
[InlineData("/traces?pane=telemetry", "/traces?pane=telemetry")]
[InlineData("/traces?pane=tags", "/traces?pane=telemetry")]
[InlineData("/traces?resource=api#details", "/traces?resource=api&pane=telemetry#details")]
public void TelemetryUrls_PreserveQueryAndFragment(string url, string expected)
{
Assert.Equal(expected, DashboardUrls.AddTelemetryPane(url));
}
[Theory]
[InlineData("resources", nameof(ResourceTab.Overview), null, false)]
[InlineData("resources/frontend", nameof(ResourceTab.Overview), "frontend", false)]
[InlineData("resources/my%20app?x=1", nameof(ResourceTab.Overview), "my app", false)]
[InlineData("resources/shell?terminal=true", nameof(ResourceTab.Terminal), "shell", false)]
[InlineData("resources/shell?pane=tags&terminal=TRUE#output", nameof(ResourceTab.Terminal), "shell", false)]
[InlineData("resources/shell?terminal=false", nameof(ResourceTab.Overview), "shell", false)]
[InlineData("resources/shell?terminal=invalid", nameof(ResourceTab.Overview), "shell", false)]
[InlineData("resources?terminal=true", nameof(ResourceTab.Overview), null, false)]
[InlineData("consolelogs", nameof(ResourceTab.Console), null, false)]
[InlineData("consolelogs/resource/frontend", nameof(ResourceTab.Console), "frontend", false)]
[InlineData("terminals", nameof(ResourceTab.Terminal), null, false)]
[InlineData("terminals/resource/shell%20%231", nameof(ResourceTab.Terminal), "shell #1", false)]
[InlineData("structuredlogs/resource/api?logLevel=error", nameof(ResourceTab.StructuredLogs), "api", false)]
[InlineData("traces", nameof(ResourceTab.Traces), null, false)]
[InlineData("traces/resource/api", nameof(ResourceTab.Traces), "api", false)]
[InlineData("traces/detail/abc123", nameof(ResourceTab.Traces), null, true)]
[InlineData("metrics/resource/api", nameof(ResourceTab.Metrics), "api", false)]
public void ParseLocation_ReturnsTabAndResource(string path, string expectedTab, string? expectedResourceName, bool expectedKeepSelection)
{
var location = ResourcesLayout.ParseLocation(path);
Assert.Equal(Enum.Parse<ResourceTab>(expectedTab), location.Tab);
Assert.Equal(expectedResourceName, location.RouteResourceName);
Assert.Equal(expectedResourceName is null ? [] : [expectedResourceName], location.SelectedResourceNames);
Assert.Equal(expectedKeepSelection, location.KeepSelection);
}
[Theory]
[InlineData("resources?resource=api&resource=worker", nameof(ResourceTab.Overview), null, new[] { "api", "worker" })]
[InlineData("consolelogs?resource=api&resource=worker&resource=api", nameof(ResourceTab.Console), null, new[] { "api", "worker" })]
[InlineData("structuredlogs?logLevel=error&resource=api&resource=my%20app", nameof(ResourceTab.StructuredLogs), null, new[] { "api", "my app" })]
[InlineData("metrics/resource/worker?resource=api&resource=worker#chart", nameof(ResourceTab.Metrics), "worker", new[] { "api", "worker" })]
[InlineData("resources/api?resource=", nameof(ResourceTab.Overview), "api", new[] { "api" })]
public void ParseLocation_ReturnsSelectedResourcesFromQuery(string path, string expectedTab, string? expectedRouteResourceName, string[] expectedSelection)
{
var location = ResourcesLayout.ParseLocation(path);
Assert.Equal(Enum.Parse<ResourceTab>(expectedTab), location.Tab);
Assert.Equal(expectedRouteResourceName, location.RouteResourceName);
Assert.Equal(expectedSelection, location.SelectedResourceNames);
Assert.False(location.KeepSelection);
}
[Theory]
[InlineData(nameof(ResourceTab.Overview), "api", "/resources/api")]
[InlineData(nameof(ResourceTab.Overview), null, "/resources")]
[InlineData(nameof(ResourceTab.Console), "api", "/consolelogs/resource/api")]
[InlineData(nameof(ResourceTab.Console), null, "/consolelogs")]
[InlineData(nameof(ResourceTab.Terminal), "shell #1", "/resources/shell%20%231?terminal=true")]
[InlineData(nameof(ResourceTab.Terminal), null, "/terminals")]
[InlineData(nameof(ResourceTab.StructuredLogs), "api", "/structuredlogs/resource/api")]
[InlineData(nameof(ResourceTab.Traces), null, "/traces")]
[InlineData(nameof(ResourceTab.Metrics), "api", "/metrics/resource/api")]
[InlineData(nameof(ResourceTab.Metrics), null, "/metrics")]
public void GetTabUrl_ReturnsTabUrl(string tab, string? resourceName, string expectedUrl)
{
Assert.Equal(expectedUrl, ResourcesLayout.GetTabUrl(Enum.Parse<ResourceTab>(tab), resourceName is null ? [] : [resourceName]));
}
[Theory]
[InlineData("/resources/shell", true, "/resources/shell?terminal=true")]
[InlineData("/resources/shell?terminal=true", true, "/resources/shell?terminal=true")]
[InlineData("/resources/shell?terminal=true", false, "/resources/shell")]
[InlineData("/resources/shell?pane=tags&terminal=true#output", false, "/resources/shell?pane=tags#output")]
[InlineData("/resources/shell?pane=tags#output", true, "/resources/shell?pane=tags&terminal=true#output")]
[InlineData("/resources/shell?resource=shell&resource=worker&terminal=true", false, "/resources/shell?resource=shell&resource=worker")]
public void TerminalFocusUrl_PreservesResourcePaneAndOtherState(string url, bool focused, string expected)
{
Assert.Equal(expected, DashboardUrls.SetResourceTerminalFocus(url, focused));
}
[Theory]
[InlineData(nameof(ResourceTab.Overview), null, "/resources?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.Console), null, "/consolelogs?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.StructuredLogs), null, "/structuredlogs?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.Traces), "api", "/traces?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.Metrics), "worker", "/metrics/resource/worker?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.Metrics), "other", "/metrics?resource=api&resource=worker")]
[InlineData(nameof(ResourceTab.Metrics), null, "/metrics?resource=api&resource=worker")]
public void GetTabUrl_WithSeveralResources_AddsSelectionToQuery(string tab, string? activeResourceName, string expectedUrl)
{
Assert.Equal(expectedUrl, ResourcesLayout.GetTabUrl(Enum.Parse<ResourceTab>(tab), ["api", "worker"], activeResourceName));
}
[Theory]
[InlineData(null, "Graph", "/graph")]
[InlineData("api", "graph", "/graph")]
[InlineData(null, "Parameters", "/resources")]
[InlineData("api", null, "/resources/api")]
[InlineData("api", "Table", "/resources/api")]
[InlineData(null, null, null)]
[InlineData("", "Table", null)]
public void TryGetLegacyRedirectUrl_MapsLegacyResourcesQuery(string? resourceName, string? viewKind, string? expectedUrl)
{
Assert.Equal(expectedUrl, Home.TryGetLegacyRedirectUrl(resourceName, viewKind));
}
[Theory]
[InlineData("graph", ResourcesPage.ResourceViewKind.Graph)]
[InlineData("graph?hiddenTypes=Container", ResourcesPage.ResourceViewKind.Graph)]
[InlineData("parameters", ResourcesPage.ResourceViewKind.Parameters)]
[InlineData("parameters#top", ResourcesPage.ResourceViewKind.Parameters)]
[InlineData("", ResourcesPage.ResourceViewKind.Table)]
public void GetViewKindFromPath_ReturnsRouteViewKind(string path, ResourcesPage.ResourceViewKind expectedViewKind)
{
Assert.Equal(expectedViewKind, ResourcesPage.GetViewKindFromPath(path));
}
[Fact]
public void HeaderSectionUrls_MatchSections()
{
Assert.Equal(NavSection.Resources, DesktopNavMenu.GetSection(DashboardUrls.HomeUrl().TrimStart('/'), hasResourceService: true));
Assert.Equal(NavSection.Resources, DesktopNavMenu.GetSection(DashboardUrls.ResourceOverviewUrl().TrimStart('/'), hasResourceService: true));
Assert.Equal(NavSection.Parameters, DesktopNavMenu.GetSection(DashboardUrls.ParametersUrl().TrimStart('/'), hasResourceService: true));
Assert.Equal(NavSection.Graph, DesktopNavMenu.GetSection(DashboardUrls.GraphUrl().TrimStart('/'), hasResourceService: true));
}
}