Files
MeterVault/tests/Integration.Tests/Localization/EnumDisplayNameTests.cs
T
Florian Schmidt bfa0b537ee
ci / build-test (push) Failing after 35s
i18n: ship the UI in English and German
The last open item on the M7 list. Number and currency formatting was
already locale-aware, but every string in the UI was an English literal,
so a German instance read half in each language -- German data, English
chrome. This translates all of it and adds the machinery to keep it
translated.

Strings live in Localization/Strings.resx (English, neutral) and
Strings.de.resx. The neutral file generates a strongly-typed accessor at
build time, aliased as S in _Imports.razor, so components reference
compiled properties -- @S.Common_Save, not a string key. That choice is
the point: across 4,500 lines of markup, a key lookup that silently
falls back to its own name is a defect you find in production, while a
renamed property is a build error. Generation runs in MSBuild rather
than the IDE designer, so dotnet build alone reproduces it anywhere.

Resource fallback is the hazard here. Ask for a key the German satellite
lacks and ResourceManager quietly serves the English one -- correct at
runtime, disastrous at release time, because a half-translated build
looks perfectly healthy. StringResourceTests reads each satellite with
tryParents: false, which is the only way to see what one actually
contains, and fails on a missing or blank translation, a placeholder
that changed arity, an orphan, or a key nothing references.

Three things needed more than substitution:

- Domain enums reached the screen as bare identifiers. They stay bare in
  the model -- they are persisted as text and appear in the REST API, so
  their names are part of the data contract -- and DisplayNames is now
  the single place that decides how each value is spoken. Every arm ends
  in a fallback returning the identifier, so a value added later cannot
  throw mid-render; EnumDisplayNameTests is what stops that safety net
  quietly becoming the shipping behaviour.

- Infrastructure was writing display text: FlowService's "Other (X)",
  MeterPeriodView's "Generation"/"Consumption", the HA connection-test
  verdicts, the updater's snackbar, the CSV importer's row warnings.
  Each now returns an outcome value and the UI supplies the words, which
  is where the reader's language is known. Diagnostics that are not ours
  -- an HTTP status, systemd's stderr, an exception message -- are passed
  through untranslated, and every English summary is kept alongside the
  outcome so log lines never move with the UI language. The UpdateRunner
  change is additive only; no gate was touched.

- Importer warnings carry their arguments rather than a finished
  sentence, so the numbers inside them pick up the reader's grouping. A
  register that reads 2.940,19 everywhere else must not read 2940.19
  only inside a warning.

Switching language is a redirect through /culture/set followed by a full
reload, not an interactive state change: a Blazor Server circuit is fixed
to the culture of the request that opened it. That makes the endpoint a
redirector taking its target from the query string, so anything but a
local path is refused rather than followed. Preference order is the
cookie, then Accept-Language, then MeterVault__Locale -- an instance can
be pinned to one language and a reader can still switch.

Locale keeps its documented default of "en". Format now follows
CurrentCulture instead of a hardcoded de-DE, so an instance with nothing
configured and a browser asking for English will show English number
formatting where it previously showed German; set MeterVault__Locale=de
to pin the old behaviour. The importer's de-DE parsing is untouched and
stays that way -- that dialect is a property of the spreadsheets, not of
whoever is looking at the dashboard.

Anything that comes from the database -- meter names, energy-type display
names, category names -- is user data and is never translated.

Claude-Session: https://claude.ai/code/session_0112ezeWqaZ85kTj5bYu9JHx
2026-08-13 16:36:25 +02:00

120 lines
4.4 KiB
C#

using System.Globalization;
using MeterVault.App.Localization;
using MeterVault.Core.Domain;
namespace MeterVault.Integration.Tests.Localization;
/// <summary>
/// Every domain enum value the UI renders has wording in every language (SDD §12, M7).
/// </summary>
/// <remarks>
/// <see cref="DisplayNames"/> ends each mapping with a fallback arm that returns the bare identifier,
/// so adding an enum value can never throw mid-render on a dashboard. The cost of that safety is that
/// a forgotten value degrades silently to English — these tests are what make it loud instead, by
/// demanding a matching <c>Enum_&lt;Type&gt;_&lt;Value&gt;</c> resource for every declared value.
/// </remarks>
public sealed class EnumDisplayNameTests
{
[Fact]
public void Every_localized_enum_value_has_a_resource_in_every_language()
{
var missing = new List<string>();
foreach (var type in DisplayNames.LocalizedEnums)
{
foreach (var name in Enum.GetNames(type))
{
// None is the empty bitmask, deliberately rendered as nothing at all.
if (type == typeof(ReadingFlags) && name == nameof(ReadingFlags.None))
{
continue;
}
var key = $"Enum_{type.Name}_{name}";
foreach (var culture in Loc.SupportedCultures)
{
var value = Strings.ResourceManager.GetString(key, CultureInfo.GetCultureInfo(culture));
if (string.IsNullOrWhiteSpace(value))
{
missing.Add($"{key} [{culture}]");
}
}
}
}
Assert.True(missing.Count == 0, $"Missing enum display names: {string.Join(", ", missing)}");
}
[Fact]
public void Display_names_are_translated_rather_than_echoing_the_identifier()
{
// Not every value can differ — "Tasmota", "Bonus" and "Global" are the same word in German —
// but if a whole enum came back as its own identifiers, the mapping was never written.
var untranslated = new List<string>();
foreach (var type in DisplayNames.LocalizedEnums)
{
var names = Enum.GetNames(type);
var translated = 0;
foreach (var name in names)
{
var german = Strings.ResourceManager.GetString($"Enum_{type.Name}_{name}", CultureInfo.GetCultureInfo("de"));
if (german is not null && !string.Equals(german, name, StringComparison.Ordinal))
{
translated++;
}
}
if (translated == 0)
{
untranslated.Add(type.Name);
}
}
Assert.True(untranslated.Count == 0, $"Enums with no German wording at all: {string.Join(", ", untranslated)}");
}
[Theory]
[InlineData("en", "Consumption")]
[InlineData("de", "Verbrauch")]
public void The_reader_s_language_decides_the_wording(string culture, string expected) =>
Assert.Equal(expected, WithUiCulture(culture, () => ConsumptionKind.Consumption.Display()));
[Fact]
public void A_bitmask_lists_the_flags_it_actually_carries()
{
// Blank rather than "None": the readings table has a flag column that is empty on almost
// every row, and printing a word down the whole page is noise, not information.
Assert.Equal(string.Empty, ReadingFlags.None.Display());
var both = WithUiCulture("de", () => (ReadingFlags.CounterReset | ReadingFlags.MeterSwap).Display());
Assert.Equal("Zählerreset, Zählerwechsel", both);
Assert.Equal("Meter swap", WithUiCulture("en", () => ReadingFlags.MeterSwap.Display()));
}
[Fact]
public void An_undeclared_enum_value_degrades_to_its_identifier_instead_of_throwing()
{
// Guards the fallback arm itself: a value cast in from the database (or a future migration)
// must not take a dashboard down.
var unknown = (MeterMode)999;
Assert.Equal("999", unknown.Display());
}
private static T WithUiCulture<T>(string culture, Func<T> body)
{
var previous = CultureInfo.CurrentUICulture;
try
{
CultureInfo.CurrentUICulture = CultureInfo.GetCultureInfo(culture);
return body();
}
finally
{
CultureInfo.CurrentUICulture = previous;
}
}
}