Skip to content

Add tests for language-tag matching: exact generic beats specifics #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imnasnainaec wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add tests for language-tag matching: exact generic beats specifics #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17c1bcd
Add tests for language-tag matching rule 3 (exact generic beats speci…
imnasnainaec Jun 5, 2026
5422adb
Remove out-of-context summaries
imnasnainaec Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 58 additions & 4 deletions src/L10NSharp.Tests/LocalizationManagerTestsBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,19 +216,19 @@ public void CreateOrUpdateDefaultTranslationFileIfNecessary_Missing_IncludesStri

Assert.AreEqual("My Own English String",
ProxyLocalizationManager.MyOwnGetString("myOwn.English.String.Id", "My Own English String"));

Assert.AreEqual("My Own English String (with comment)",
ProxyLocalizationManager.MyOwnGetString("myOwn.English.String.Id.With.Comment",
"My Own English String (with comment)",
"This is used to test the case where MyOwnGetString is passed as an extra method to use for extraction."));

Assert.AreEqual("Click me",
ProxyLocalizationManager.MyOwnGetString("myDlg.btnClickMe.Text", "Click me",
"This is the text from the third version of MyOwnGetString.",
"Click this thingy to do stuff.", "Ctrl-T", btnClickMe));

Assert.AreEqual("String to Localize", "String to Localize".Localize());

Assert.AreEqual("Another String to Localize", "Another String to Localize".Localize("With.Id.And.Comment",
"This is used to test the case where Localize is passed as an extra method to use for extraction."));
}
Expand Down Expand Up @@ -615,6 +615,29 @@ private void AddChineseOfTaiwanTranslation(string folderPath)
chineseDoc.Save(Path.Combine(folderPath, LocalizationManager.GetTranslationFileNameForLanguage(AppId, "zh-TW")));
}

private void AddChineseBareTranslation(string folderPath)
{
var chineseDoc = CreateNewDocument(null, "en", "zh");
// first unit
var tu = CreateTransUnit("theId", false,
CreateTransUnitVariant("en", "from English Translation"),
CreateTransUnitVariant("zh", "from Chinese (generic) Translation"),
"Test", TranslationStatus.Approved);
chineseDoc.AddTransUnit(tu);
// second unit
var tu2 = CreateTransUnit("notUsedId", false,
CreateTransUnitVariant("en", "no longer used English text"),
CreateTransUnitVariant("zh", "no longer used Chinese (generic) text"),
null, TranslationStatus.Approved);
chineseDoc.AddTransUnit(tu2);
// third unit
var tu3 = CreateTransUnit("blahId", false,
CreateTransUnitVariant("en", "blah"),
CreateTransUnitVariant("zh", "中文 blah"));
chineseDoc.AddTransUnit(tu3);
chineseDoc.Save(Path.Combine(folderPath, LocalizationManager.GetTranslationFileNameForLanguage(AppId, "zh")));
}

protected void AddRandomTranslation(string langId, string folderPath)
{
var doc = CreateNewDocument(null, "en", langId);
Expand Down Expand Up @@ -1006,5 +1029,36 @@ public void TestMappingLanguageCodesToAvailable_FindsSpecificGivenGeneric()
Assert.That(languageIdUsed, Is.EqualTo("zh-CN"));
}
}

[Test]
public void TestMappingLanguageCodesToAvailable_ExactGenericMatchUsedWhenSpecificsAlsoExist()
{
LocalizationManager.SetUILanguage("en");
LocalizationManagerInternal<T>.LoadedManagers.Clear();
using (var folder = new TempFolder())
{
var installedFolder = Path.Combine(folder.Path, "installed");
AddEnglishTranslation(installedFolder, null);
AddChineseBareTranslation(installedFolder);
AddChineseOfChinaTranslation(installedFolder);
AddChineseOfTaiwanTranslation(installedFolder);
LocalizationManagerInternal<T>.ChooseFallbackLanguage();
var manager = LocalizationManager.Create("zh", AppId, AppName, AppVersion, installedFolder,
$"Temp/{Path.GetFileName(folder.Path)}/user", new string[] { });
LocalizationManagerInternal<T>.LoadedManagers[AppId] = (ILocalizationManagerInternal<T>)manager;

// The UI language should be set to the exact match "zh", not one of the specifics.
Assert.That(LocalizationManager.UILanguageId, Is.EqualTo("zh"));

Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh"), Is.True, "zh should find zh (exact)");
Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh-CN"), Is.True, "zh-CN should find zh-CN");
Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh-TW"), Is.True, "zh-TW should find zh-TW");

// The generic zh request should use the generic zh translation, not CN or TW.
var str = LocalizationManager.GetString("theId", ".", "", new[] { "zh" }, out var languageIdUsed);
Assert.That(str, Is.EqualTo("from Chinese (generic) Translation"));
Assert.That(languageIdUsed, Is.EqualTo("zh"));
}
}
}
}
62 changes: 62 additions & 0 deletions src/L10NSharp.Windows.Forms.Tests/XliffLocalizationManagerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,29 @@ private void AddChineseOfTaiwanTranslation(string folderPath)
chineseDoc.Save(Path.Combine(folderPath, LocalizationManager.GetTranslationFileNameForLanguage(AppId, "zh-TW")));
}

private void AddChineseBareTranslation(string folderPath)
{
var chineseDoc = CreateNewDocument(null, "en", "zh");
// first unit
var tu = CreateTransUnit("theId", false,
CreateTransUnitVariant("en", "from English Translation"),
CreateTransUnitVariant("zh", "from Chinese (generic) Translation"),
"Test", TranslationStatus.Approved);
chineseDoc.AddTransUnit(tu);
// second unit
var tu2 = CreateTransUnit("notUsedId", false,
CreateTransUnitVariant("en", "no longer used English text"),
CreateTransUnitVariant("zh", "no longer used Chinese (generic) text"),
null, TranslationStatus.Approved);
chineseDoc.AddTransUnit(tu2);
// third unit
var tu3 = CreateTransUnit("blahId", false,
CreateTransUnitVariant("en", "blah"),
CreateTransUnitVariant("zh", "中文 blah"));
chineseDoc.AddTransUnit(tu3);
chineseDoc.Save(Path.Combine(folderPath, LocalizationManager.GetTranslationFileNameForLanguage(AppId, "zh")));
}

[Test]
public void TestMappingLanguageCodesToAvailable_AmbiguousOptions_PromptsUser([Values("zh-CN", "zh-TW")] string choice)
{
Expand Down Expand Up @@ -193,5 +216,44 @@ public void TestMappingLanguageCodesToAvailable_AmbiguousOptions_PromptsUser([Va
Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "en"), Is.True, "en should find en");
}
}

[Test]
public void TestMappingLanguageCodesToAvailable_ExactGenericMatchUsedWhenSpecificsAlsoExist()
{
LocalizationManagerWinforms.SetUILanguage("en", true);
LocalizationManagerInternalWinforms<XLiffDocument>.LoadedManagers.Clear();
using (var folder = new L10NSharp.Tests.TempFolder())
{
var installedFolder = Path.Combine(folder.Path, "installed");
// ReSharper disable once AssignNullToNotNullAttribute
var userRelativeFolder = Path.Combine("Temp", Path.GetFileName(Path.GetDirectoryName(folder.Path)),
Path.GetFileName(folder.Path), "user");
AddEnglishTranslation(installedFolder, null);
AddChineseBareTranslation(installedFolder);
AddChineseOfChinaTranslation(installedFolder);
AddChineseOfTaiwanTranslation(installedFolder);
var userPromptCount = 0;
LocalizationManagerInternalWinforms<XLiffDocument>.ChooseFallbackLanguageWinforms = (langTag, icon) =>
{
userPromptCount++;
return langTag;
};
var manager = LocalizationManagerWinforms.Create("zh", AppId, AppName, AppVersion, installedFolder,
userRelativeFolder, null, new string[] { });
// Exact match available — no prompt should have been shown.
Assert.That(userPromptCount, Is.EqualTo(0));
Assert.That(LocalizationManager.UILanguageId, Is.EqualTo("zh"));
LocalizationManagerInternal<XLiffDocument>.LoadedManagers[AppId] = (ILocalizationManagerInternal<XLiffDocument>)manager;

Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh"), Is.True, "zh should find zh (exact)");
Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh-CN"), Is.True, "zh-CN should find zh-CN");
Assert.That(LocalizationManager.GetIsStringAvailableForLangId("theId", "zh-TW"), Is.True, "zh-TW should find zh-TW");

// The generic zh request should use the generic zh translation, not CN or TW.
var str = LocalizationManager.GetString("theId", ".", "", new[] { "zh" }, out var languageIdUsed);
Assert.That(str, Is.EqualTo("from Chinese (generic) Translation"));
Assert.That(languageIdUsed, Is.EqualTo("zh"));
}
}
}
}
Loading