|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Immutable;
using System.Threading.Channels;
using Aspire.Dashboard.Components.Resize;
using Aspire.Dashboard.Components.Tests.Shared;
using Aspire.Dashboard.Model;
using Aspire.Dashboard.Model.BrowserStorage;
using Aspire.Dashboard.Tests.Shared;
using Aspire.Dashboard.Utils;
using Bunit;
using ProtobufValue = Google.Protobuf.WellKnownTypes.Value;
using Microsoft.AspNetCore.Components;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.FluentUI.AspNetCore.Components;
using Xunit;
namespace Aspire.Dashboard.Components.Tests.Pages;
[UseCulture("en-US")]
public partial class ResourcesTests : DashboardTestContext
{
[Fact]
public void UpdateResources_FiltersUpdated()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource(
"Resource1",
"Type1",
"Running",
ImmutableArray.Create(new HealthReportViewModel("Null", null, "Description1", null))),
};
var channel = Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>();
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: () => channel);
ResourceSetupHelpers.SetupResourcesPage(
this,
viewport,
dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Assert 1
Assert.Collection(cut.Instance.PageViewModel.ResourceTypesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Type1", kvp.Key);
Assert.True(kvp.Value);
});
Assert.Collection(cut.Instance.PageViewModel.ResourceStatesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Running", kvp.Key);
Assert.True(kvp.Value);
});
Assert.Collection(cut.Instance.PageViewModel.ResourceHealthStatusesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Unhealthy", kvp.Key);
Assert.True(kvp.Value);
});
// Act
channel.Writer.TryWrite([
new ResourceViewModelChange(
ResourceViewModelChangeType.Upsert,
CreateResource(
"Resource2",
"Type2",
"Running",
ImmutableArray.Create(new HealthReportViewModel("Healthy", HealthStatus.Healthy, "Description2", null))))
]);
cut.WaitForState(() => cut.Instance.GetFilteredResources().Count() == 2);
// Assert 2
Assert.Collection(cut.Instance.PageViewModel.ResourceTypesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Type1", kvp.Key);
Assert.True(kvp.Value);
},
kvp =>
{
Assert.Equal("Type2", kvp.Key);
Assert.True(kvp.Value);
});
Assert.Collection(cut.Instance.PageViewModel.ResourceStatesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Running", kvp.Key);
Assert.True(kvp.Value);
});
Assert.Collection(cut.Instance.PageViewModel.ResourceHealthStatusesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Healthy", kvp.Key);
Assert.True(kvp.Value);
},
kvp =>
{
Assert.Equal("Unhealthy", kvp.Key);
Assert.True(kvp.Value);
});
}
[Fact]
public void FilterResources()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource(
"Resource1",
"Type1",
"Running",
ImmutableArray.Create(new HealthReportViewModel("Null", null, "Description1", null))),
CreateResource(
"Resource2",
"Type2",
"Running",
ImmutableArray.Create(new HealthReportViewModel("Healthy", HealthStatus.Healthy, "Description2", null))),
CreateResource(
"Resource3",
"Type3",
"Stopping",
ImmutableArray.Create(new HealthReportViewModel("Degraded", HealthStatus.Degraded, "Description3", null))),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(
this,
viewport,
dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Open the resource filter
cut.Find("#resourceFilterButton").Click();
// Assert 1 (the correct filter options are shown)
AssertResourceFilterListEquals(cut, [
new("Type1", true),
new("Type2", true),
new("Type3", true),
], [
new("Running", true),
new("Stopping", true),
], [
new("", true),
new("Healthy", true),
new("Unhealthy", true),
]);
// Assert 2 (unselect a resource type, assert that a resource was removed)
cut.FindComponents<SelectResourceOptions<string>>().First(f => f.Instance.Id == "resource-states")
.FindComponents<FluentCheckbox>()
.First(checkbox => checkbox.Instance.Label == "Stopping")
.Find("fluent-checkbox")
.TriggerEvent("oncheckedchange", new CheckboxChangeEventArgs { Checked = false });
// above is triggered asynchronously, so wait for the state to change
cut.WaitForState(() => cut.Instance.GetFilteredResources().Count() == 2);
}
[Fact]
public void ResourceGraph_MultipleRenders_InitializeOnce()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource(
"Resource1",
"Type1",
"Running",
ImmutableArray.Create(new HealthReportViewModel("Null", null, "Description1", null))),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(
this,
viewport,
dashboardClient);
var resourceGraphModule = JSInterop.SetupModule("/js/app-resourcegraph.js");
var initializeGraphInvocationHandler = resourceGraphModule.SetupVoid("initializeResourcesGraph", _ => true);
var navigationManager = Services.GetRequiredService<NavigationManager>();
navigationManager.NavigateTo(DashboardUrls.ResourcesUrl(view: "Graph"));
// Act
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
cut.Render();
// Assert
Assert.Single(initializeGraphInvocationHandler.Invocations);
}
[Fact]
public void ResourceFilters_ApplyExistingFiltersOnInitialRender()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("Resource1", "Type1", "Running", null),
CreateResource("Resource2", "Type2", "Finished", null),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources,
resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var sessionStorage = (TestSessionStorage)Services.GetRequiredService<ISessionStorage>();
// Simulate existing filters in session storage
sessionStorage.OnGetAsync = key =>
{
if (key is BrowserStorageKeys.ResourcesPageState)
{
return (true,
new Components.Pages.Resources.ResourcesPageState
{
ResourceTypesToVisibility =
new Dictionary<string, bool> { { "Type1", true }, { "Type2", false } },
ResourceStatesToVisibility =
new Dictionary<string, bool> { { "Running", true }, { "Finished", false } },
ResourceHealthStatusesToVisibility =
new Dictionary<string, bool> { { "Healthy", true }, { "Unhealthy", false } },
ViewKind = null,
});
}
return (false, null);
};
// Act and assert
var cut = RenderComponent<Components.Pages.Resources>(builder => { builder.AddCascadingValue(viewport); });
Assert.Collection(cut.Instance.PageViewModel.ResourceTypesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Type1", kvp.Key);
Assert.True(kvp.Value);
},
kvp =>
{
Assert.Equal("Type2", kvp.Key);
Assert.False(kvp.Value);
});
Assert.Collection(cut.Instance.PageViewModel.ResourceStatesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal("Finished", kvp.Key);
Assert.False(kvp.Value);
},
kvp =>
{
Assert.Equal("Running", kvp.Key);
Assert.True(kvp.Value);
});
// Unhealthy not included because it's not present in any resource
Assert.Collection(cut.Instance.PageViewModel.ResourceHealthStatusesToVisibility.OrderBy(kvp => kvp.Key),
kvp =>
{
Assert.Equal(string.Empty, kvp.Key);
Assert.True(kvp.Value);
},
kvp =>
{
Assert.Equal("Healthy", kvp.Key);
Assert.True(kvp.Value);
});
}
private static void AssertResourceFilterListEquals(IRenderedComponent<Components.Pages.Resources> cut, IEnumerable<KeyValuePair<string, bool>> types, IEnumerable<KeyValuePair<string, bool>> states, IEnumerable<KeyValuePair<string, bool>> healthStates)
{
IReadOnlyList<IRenderedComponent<SelectResourceOptions<string>>> filterComponents = null!;
cut.WaitForState(() =>
{
filterComponents = cut.FindComponents<SelectResourceOptions<string>>();
return filterComponents.Count == 3;
});
var typeSelect = filterComponents.First(f => f.Instance.Id == "resource-types");
Assert.Equal(types, typeSelect.Instance.Values.ToImmutableSortedDictionary() /* sort for equality comparison */ );
var stateSelect = filterComponents.First(f => f.Instance.Id == "resource-states");
Assert.Equal(states, stateSelect.Instance.Values.ToImmutableSortedDictionary() /* sort for equality comparison */);
var healthSelect = filterComponents.First(f => f.Instance.Id == "resource-health-states");
Assert.Equal(healthStates, healthSelect.Instance.Values.ToImmutableSortedDictionary() /* sort for equality comparison */);
}
[Fact]
public void ResourcesShouldRemainUnchangedWhenFilterDoesNotMatchUpdatedResource()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("Resource1", "Type1", "Running", null),
CreateResource("Resource2", "Type2", "Stopping", null),
};
var channel = Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>();
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: () => channel);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Open the resource filter and apply a filter
cut.Find("#resourceFilterButton").Click();
cut.FindComponents<SelectResourceOptions<string>>()
.First(f => f.Instance.Id == "resource-types")
.FindComponents<FluentCheckbox>()
.First(checkbox => checkbox.Instance.Label == "Type1")
.Find("fluent-checkbox")
.TriggerEvent("oncheckedchange", new CheckboxChangeEventArgs { Checked = false });
cut.WaitForState(() => cut.Instance.GetFilteredResources().Count() == 1);
// Act
channel.Writer.TryWrite(new[]
{
new ResourceViewModelChange(
ResourceViewModelChangeType.Upsert,
CreateResource("Resource3", "Type3", "Running", null))
});
cut.WaitForState(() => cut.Instance.GetFilteredResources().Count() == 2);
// Assert
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Contains(filteredResources, r => r.Name == "Resource2");
Assert.Contains(filteredResources, r => r.Name == "Resource3");
}
private static ResourceViewModel CreateResource(
string name,
string type,
string? state,
ImmutableArray<HealthReportViewModel>? healthReports,
bool isHidden = false,
string? stateStyle = null,
ImmutableDictionary<string, ResourcePropertyViewModel>? properties = null)
{
return new ResourceViewModel
{
Name = name,
ResourceType = type,
State = state,
KnownState = state is not null && Enum.TryParse<KnownResourceState>(state, out var knownState) ? knownState : null,
DisplayName = name,
Uid = name,
HealthReports = healthReports ?? [],
StateStyle = stateStyle,
CreationTimeStamp = null,
StartTimeStamp = null,
StopTimeStamp = null,
Environment = default,
Urls = [],
Volumes = default,
Relationships = default,
Properties = properties ?? ImmutableDictionary<string, ResourcePropertyViewModel>.Empty,
Commands = [],
IsHidden = isHidden,
};
}
[Fact]
public void ViewOptionsMenuIsVisibleWhenHiddenResourcesExist()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("Resource1", "Type1", "Running", null),
CreateResource("HiddenResource", "Type2", null, null, isHidden: true), // Hidden resource without parent relationship
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(
this,
viewport,
dashboardClient);
// Act
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Assert - the menu button should be present (it contains the "Show hidden resources" option)
var menuButton = cut.FindComponent<AspireMenuButton>();
Assert.NotNull(menuButton);
}
[Fact]
public void TableView_ExcludesParameters()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("myapp", "Project", "Running", null),
CreateResource("mycontainer", "Container", "Running", null),
CreateResource("myparameter", KnownResourceTypes.Parameter, "Running", null),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
// Act
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Assert - Table view (default) should exclude parameters
Assert.Equal(Components.Pages.Resources.ResourceViewKind.Table, cut.Instance.PageViewModel.SelectedViewKind);
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Equal(2, filteredResources.Count);
Assert.Contains(filteredResources, r => r.Name == "myapp");
Assert.Contains(filteredResources, r => r.Name == "mycontainer");
Assert.DoesNotContain(filteredResources, r => r.Name == "myparameter");
}
[Fact]
public void ParametersView_ShowsOnlyParameters()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("myapp", "Project", "Running", null),
CreateResource("mycontainer", "Container", "Running", null),
CreateResource("myparameter1", KnownResourceTypes.Parameter, "Running", null),
CreateResource("myparameter2", KnownResourceTypes.Parameter, "Running", null),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Act - switch to Parameters view
cut.Instance.PageViewModel.SelectedViewKind = Components.Pages.Resources.ResourceViewKind.Parameters;
cut.Render();
// Assert - Parameters view should show only parameters
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Equal(2, filteredResources.Count);
Assert.Contains(filteredResources, r => r.Name == "myparameter1");
Assert.Contains(filteredResources, r => r.Name == "myparameter2");
Assert.DoesNotContain(filteredResources, r => r.Name == "myapp");
Assert.DoesNotContain(filteredResources, r => r.Name == "mycontainer");
}
[Fact]
public void GraphView_ShowsAllResources()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var initialResources = new List<ResourceViewModel>
{
CreateResource("myapp", "Project", "Running", null),
CreateResource("myparameter", KnownResourceTypes.Parameter, "Running", null),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var resourceGraphModule = JSInterop.SetupModule("/js/app-resourcegraph.js");
resourceGraphModule.SetupVoid("initializeResourcesGraph", _ => true);
resourceGraphModule.SetupVoid("updateResourcesGraph", _ => true);
resourceGraphModule.SetupVoid("updateResourcesGraphSelected", _ => true);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Act - switch to Graph view
cut.Instance.PageViewModel.SelectedViewKind = Components.Pages.Resources.ResourceViewKind.Graph;
cut.Render();
// Assert - Graph view should show all resources (no parameter filtering)
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Equal(2, filteredResources.Count);
Assert.Contains(filteredResources, r => r.Name == "myapp");
Assert.Contains(filteredResources, r => r.Name == "myparameter");
}
[Fact]
public void ParametersView_IncludesParametersWithValues()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var parameterProperties = ImmutableDictionary<string, ResourcePropertyViewModel>.Empty
.Add(KnownProperties.Parameter.Value, new ResourcePropertyViewModel(
KnownProperties.Parameter.Value,
ProtobufValue.ForString("my-secret-value"),
isValueSensitive: true,
knownProperty: null,
priority: 0));
var initialResources = new List<ResourceViewModel>
{
CreateResource("myparameter", KnownResourceTypes.Parameter, "Running", null, stateStyle: "success", properties: parameterProperties),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Act - switch to Parameters view
cut.Instance.PageViewModel.SelectedViewKind = Components.Pages.Resources.ResourceViewKind.Parameters;
cut.Render();
// Assert - The parameter should be displayed in Parameters view
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Single(filteredResources);
Assert.Equal("myparameter", filteredResources[0].Name);
// Verify the resource has the expected properties for value display
var resource = filteredResources[0];
Assert.True(resource.Properties.ContainsKey(KnownProperties.Parameter.Value));
Assert.Equal("my-secret-value", resource.Properties[KnownProperties.Parameter.Value].Value.StringValue);
Assert.True(resource.Properties[KnownProperties.Parameter.Value].IsValueSensitive);
Assert.Equal("success", resource.StateStyle);
}
[Fact]
public void ParametersView_IncludesUnresolvedParameters()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
// Unresolved parameter has warning stateStyle and exception message as value
var parameterProperties = ImmutableDictionary<string, ResourcePropertyViewModel>.Empty
.Add(KnownProperties.Parameter.Value, new ResourcePropertyViewModel(
KnownProperties.Parameter.Value,
ProtobufValue.ForString("Parameter 'myparameter' not found in configuration."),
isValueSensitive: false,
knownProperty: null,
priority: 0));
var initialResources = new List<ResourceViewModel>
{
CreateResource("myparameter", KnownResourceTypes.Parameter, "Value missing", null, stateStyle: "warning", properties: parameterProperties),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Act - switch to Parameters view
cut.Instance.PageViewModel.SelectedViewKind = Components.Pages.Resources.ResourceViewKind.Parameters;
cut.Render();
// Assert - The unresolved parameter should be displayed in Parameters view
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Single(filteredResources);
Assert.Equal("myparameter", filteredResources[0].Name);
// Verify the resource has warning stateStyle (triggers "Value not set" display)
var resource = filteredResources[0];
Assert.Equal("warning", resource.StateStyle);
Assert.Equal("Value missing", resource.State);
}
[Fact]
public void ParametersView_IncludesErrorParameters()
{
// Arrange
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
// Error parameter has error stateStyle
var parameterProperties = ImmutableDictionary<string, ResourcePropertyViewModel>.Empty
.Add(KnownProperties.Parameter.Value, new ResourcePropertyViewModel(
KnownProperties.Parameter.Value,
ProtobufValue.ForString("Error initializing parameter"),
isValueSensitive: false,
knownProperty: null,
priority: 0));
var initialResources = new List<ResourceViewModel>
{
CreateResource("myparameter", KnownResourceTypes.Parameter, "Error", null, stateStyle: "error", properties: parameterProperties),
};
var dashboardClient = new TestDashboardClient(isEnabled: true, initialResources: initialResources, resourceChannelProvider: Channel.CreateUnbounded<IReadOnlyList<ResourceViewModelChange>>);
ResourceSetupHelpers.SetupResourcesPage(this, viewport, dashboardClient);
var cut = RenderComponent<Components.Pages.Resources>(builder =>
{
builder.AddCascadingValue(viewport);
});
// Act - switch to Parameters view
cut.Instance.PageViewModel.SelectedViewKind = Components.Pages.Resources.ResourceViewKind.Parameters;
cut.Render();
// Assert - The error parameter should be displayed in Parameters view
var filteredResources = cut.Instance.GetFilteredResources().ToList();
Assert.Single(filteredResources);
Assert.Equal("myparameter", filteredResources[0].Name);
// Verify the resource has error stateStyle (triggers "Value not set" display)
var resource = filteredResources[0];
Assert.Equal("error", resource.StateStyle);
}
}
|