* Throw proper exception when missing resource
This commit is contained in:
parent
2ce31c5122
commit
f3855b9cf2
|
|
@ -0,0 +1,62 @@
|
||||||
|
// <auto-generated />
|
||||||
|
namespace Microsoft.Extensions.Localization
|
||||||
|
{
|
||||||
|
using System.Globalization;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Resources;
|
||||||
|
|
||||||
|
internal static class Resources
|
||||||
|
{
|
||||||
|
private static readonly ResourceManager _resourceManager
|
||||||
|
= new ResourceManager("Microsoft.Extensions.Localization.Resources", typeof(Resources).GetTypeInfo().Assembly);
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The manifest '{0}' was not found.
|
||||||
|
/// </summary>
|
||||||
|
internal static string Localization_MissingManifest
|
||||||
|
{
|
||||||
|
get { return GetString("Localization_MissingManifest"); }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The manifest '{0}' was not found.
|
||||||
|
/// </summary>
|
||||||
|
internal static string FormatLocalization_MissingManifest(object p0)
|
||||||
|
{
|
||||||
|
return string.Format(CultureInfo.CurrentCulture, GetString("Localization_MissingManifest"), p0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// No manifests exist for the current culture.
|
||||||
|
/// </summary>
|
||||||
|
internal static string Localization_MissingManifest_Parent
|
||||||
|
{
|
||||||
|
get { return GetString("Localization_MissingManifest_Parent"); }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// No manifests exist for the current culture.
|
||||||
|
/// </summary>
|
||||||
|
internal static string FormatLocalization_MissingManifest_Parent()
|
||||||
|
{
|
||||||
|
return GetString("Localization_MissingManifest_Parent");
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string GetString(string name, params string[] formatterNames)
|
||||||
|
{
|
||||||
|
var value = _resourceManager.GetString(name);
|
||||||
|
|
||||||
|
System.Diagnostics.Debug.Assert(value != null);
|
||||||
|
|
||||||
|
if (formatterNames != null)
|
||||||
|
{
|
||||||
|
for (var i = 0; i < formatterNames.Length; i++)
|
||||||
|
{
|
||||||
|
value = value.Replace("{" + formatterNames[i] + "}", "{" + i + "}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -153,6 +153,13 @@ namespace Microsoft.Extensions.Localization
|
||||||
? GetResourceNamesFromCultureHierarchy(culture)
|
? GetResourceNamesFromCultureHierarchy(culture)
|
||||||
: GetResourceNamesForCulture(culture);
|
: GetResourceNamesForCulture(culture);
|
||||||
|
|
||||||
|
if (resourceNames == null && !includeParentCultures)
|
||||||
|
{
|
||||||
|
var resourceStreamName = GetResourceStreamName(culture);
|
||||||
|
throw new MissingManifestResourceException(
|
||||||
|
Resources.FormatLocalization_MissingManifest(resourceStreamName));
|
||||||
|
}
|
||||||
|
|
||||||
foreach (var name in resourceNames)
|
foreach (var name in resourceNames)
|
||||||
{
|
{
|
||||||
var value = GetStringSafely(name, culture);
|
var value = GetStringSafely(name, culture);
|
||||||
|
|
@ -197,17 +204,21 @@ namespace Microsoft.Extensions.Localization
|
||||||
var currentCulture = startingCulture;
|
var currentCulture = startingCulture;
|
||||||
var resourceNames = new HashSet<string>();
|
var resourceNames = new HashSet<string>();
|
||||||
|
|
||||||
|
var hasAnyCultures = false;
|
||||||
|
|
||||||
while (true)
|
while (true)
|
||||||
{
|
{
|
||||||
try
|
|
||||||
|
var cultureResourceNames = GetResourceNamesForCulture(currentCulture);
|
||||||
|
|
||||||
|
if (cultureResourceNames != null)
|
||||||
{
|
{
|
||||||
var cultureResourceNames = GetResourceNamesForCulture(currentCulture);
|
|
||||||
foreach (var resourceName in cultureResourceNames)
|
foreach (var resourceName in cultureResourceNames)
|
||||||
{
|
{
|
||||||
resourceNames.Add(resourceName);
|
resourceNames.Add(resourceName);
|
||||||
}
|
}
|
||||||
|
hasAnyCultures = true;
|
||||||
}
|
}
|
||||||
catch (MissingManifestResourceException) { }
|
|
||||||
|
|
||||||
if (currentCulture == currentCulture.Parent)
|
if (currentCulture == currentCulture.Parent)
|
||||||
{
|
{
|
||||||
|
|
@ -218,10 +229,15 @@ namespace Microsoft.Extensions.Localization
|
||||||
currentCulture = currentCulture.Parent;
|
currentCulture = currentCulture.Parent;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (!hasAnyCultures)
|
||||||
|
{
|
||||||
|
throw new MissingManifestResourceException(Resources.Localization_MissingManifest_Parent);
|
||||||
|
}
|
||||||
|
|
||||||
return resourceNames;
|
return resourceNames;
|
||||||
}
|
}
|
||||||
|
|
||||||
private IList<string> GetResourceNamesForCulture(CultureInfo culture)
|
private string GetResourceStreamName(CultureInfo culture)
|
||||||
{
|
{
|
||||||
var resourceStreamName = _resourceBaseName;
|
var resourceStreamName = _resourceBaseName;
|
||||||
if (!string.IsNullOrEmpty(culture.Name))
|
if (!string.IsNullOrEmpty(culture.Name))
|
||||||
|
|
@ -230,22 +246,36 @@ namespace Microsoft.Extensions.Localization
|
||||||
}
|
}
|
||||||
resourceStreamName += ".resources";
|
resourceStreamName += ".resources";
|
||||||
|
|
||||||
|
return resourceStreamName;
|
||||||
|
}
|
||||||
|
|
||||||
|
private IList<string> GetResourceNamesForCulture(CultureInfo culture)
|
||||||
|
{
|
||||||
|
var resourceStreamName = GetResourceStreamName(culture);
|
||||||
|
|
||||||
var cacheKey = $"assembly={_resourceAssemblyWrapper.FullName};resourceStreamName={resourceStreamName}";
|
var cacheKey = $"assembly={_resourceAssemblyWrapper.FullName};resourceStreamName={resourceStreamName}";
|
||||||
|
|
||||||
var cultureResourceNames = _resourceNamesCache.GetOrAdd(cacheKey, _ =>
|
var cultureResourceNames = _resourceNamesCache.GetOrAdd(cacheKey, _ =>
|
||||||
{
|
{
|
||||||
var names = new List<string>();
|
|
||||||
using (var cultureResourceStream = _resourceAssemblyWrapper.GetManifestResourceStream(resourceStreamName))
|
using (var cultureResourceStream = _resourceAssemblyWrapper.GetManifestResourceStream(resourceStreamName))
|
||||||
using (var resources = new ResourceReader(cultureResourceStream))
|
|
||||||
{
|
{
|
||||||
foreach (DictionaryEntry entry in resources)
|
if (cultureResourceStream == null)
|
||||||
{
|
{
|
||||||
var resourceName = (string)entry.Key;
|
return null;
|
||||||
names.Add(resourceName);
|
}
|
||||||
|
|
||||||
|
using (var resources = new ResourceReader(cultureResourceStream))
|
||||||
|
{
|
||||||
|
var names = new List<string>();
|
||||||
|
foreach (DictionaryEntry entry in resources)
|
||||||
|
{
|
||||||
|
var resourceName = (string)entry.Key;
|
||||||
|
names.Add(resourceName);
|
||||||
|
}
|
||||||
|
return names;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return names;
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return cultureResourceNames;
|
return cultureResourceNames;
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,126 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<root>
|
||||||
|
<!--
|
||||||
|
Microsoft ResX Schema
|
||||||
|
|
||||||
|
Version 2.0
|
||||||
|
|
||||||
|
The primary goals of this format is to allow a simple XML format
|
||||||
|
that is mostly human readable. The generation and parsing of the
|
||||||
|
various data types are done through the TypeConverter classes
|
||||||
|
associated with the data types.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
... ado.net/XML headers & schema ...
|
||||||
|
<resheader name="resmimetype">text/microsoft-resx</resheader>
|
||||||
|
<resheader name="version">2.0</resheader>
|
||||||
|
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
|
||||||
|
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
|
||||||
|
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
|
||||||
|
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
|
||||||
|
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
|
||||||
|
<value>[base64 mime encoded serialized .NET Framework object]</value>
|
||||||
|
</data>
|
||||||
|
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
|
||||||
|
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
|
||||||
|
<comment>This is a comment</comment>
|
||||||
|
</data>
|
||||||
|
|
||||||
|
There are any number of "resheader" rows that contain simple
|
||||||
|
name/value pairs.
|
||||||
|
|
||||||
|
Each data row contains a name, and value. The row also contains a
|
||||||
|
type or mimetype. Type corresponds to a .NET class that support
|
||||||
|
text/value conversion through the TypeConverter architecture.
|
||||||
|
Classes that don't support this are serialized and stored with the
|
||||||
|
mimetype set.
|
||||||
|
|
||||||
|
The mimetype is used for serialized objects, and tells the
|
||||||
|
ResXResourceReader how to depersist the object. This is currently not
|
||||||
|
extensible. For a given mimetype the value must be set accordingly:
|
||||||
|
|
||||||
|
Note - application/x-microsoft.net.object.binary.base64 is the format
|
||||||
|
that the ResXResourceWriter will generate, however the reader can
|
||||||
|
read any of the formats listed below.
|
||||||
|
|
||||||
|
mimetype: application/x-microsoft.net.object.binary.base64
|
||||||
|
value : The object must be serialized with
|
||||||
|
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
|
||||||
|
: and then encoded with base64 encoding.
|
||||||
|
|
||||||
|
mimetype: application/x-microsoft.net.object.soap.base64
|
||||||
|
value : The object must be serialized with
|
||||||
|
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
|
||||||
|
: and then encoded with base64 encoding.
|
||||||
|
|
||||||
|
mimetype: application/x-microsoft.net.object.bytearray.base64
|
||||||
|
value : The object must be serialized into a byte array
|
||||||
|
: using a System.ComponentModel.TypeConverter
|
||||||
|
: and then encoded with base64 encoding.
|
||||||
|
-->
|
||||||
|
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
|
||||||
|
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
|
||||||
|
<xsd:element name="root" msdata:IsDataSet="true">
|
||||||
|
<xsd:complexType>
|
||||||
|
<xsd:choice maxOccurs="unbounded">
|
||||||
|
<xsd:element name="metadata">
|
||||||
|
<xsd:complexType>
|
||||||
|
<xsd:sequence>
|
||||||
|
<xsd:element name="value" type="xsd:string" minOccurs="0" />
|
||||||
|
</xsd:sequence>
|
||||||
|
<xsd:attribute name="name" use="required" type="xsd:string" />
|
||||||
|
<xsd:attribute name="type" type="xsd:string" />
|
||||||
|
<xsd:attribute name="mimetype" type="xsd:string" />
|
||||||
|
<xsd:attribute ref="xml:space" />
|
||||||
|
</xsd:complexType>
|
||||||
|
</xsd:element>
|
||||||
|
<xsd:element name="assembly">
|
||||||
|
<xsd:complexType>
|
||||||
|
<xsd:attribute name="alias" type="xsd:string" />
|
||||||
|
<xsd:attribute name="name" type="xsd:string" />
|
||||||
|
</xsd:complexType>
|
||||||
|
</xsd:element>
|
||||||
|
<xsd:element name="data">
|
||||||
|
<xsd:complexType>
|
||||||
|
<xsd:sequence>
|
||||||
|
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
|
||||||
|
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
|
||||||
|
</xsd:sequence>
|
||||||
|
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
|
||||||
|
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
|
||||||
|
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
|
||||||
|
<xsd:attribute ref="xml:space" />
|
||||||
|
</xsd:complexType>
|
||||||
|
</xsd:element>
|
||||||
|
<xsd:element name="resheader">
|
||||||
|
<xsd:complexType>
|
||||||
|
<xsd:sequence>
|
||||||
|
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
|
||||||
|
</xsd:sequence>
|
||||||
|
<xsd:attribute name="name" type="xsd:string" use="required" />
|
||||||
|
</xsd:complexType>
|
||||||
|
</xsd:element>
|
||||||
|
</xsd:choice>
|
||||||
|
</xsd:complexType>
|
||||||
|
</xsd:element>
|
||||||
|
</xsd:schema>
|
||||||
|
<resheader name="resmimetype">
|
||||||
|
<value>text/microsoft-resx</value>
|
||||||
|
</resheader>
|
||||||
|
<resheader name="version">
|
||||||
|
<value>2.0</value>
|
||||||
|
</resheader>
|
||||||
|
<resheader name="reader">
|
||||||
|
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
|
||||||
|
</resheader>
|
||||||
|
<resheader name="writer">
|
||||||
|
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
|
||||||
|
</resheader>
|
||||||
|
<data name="Localization_MissingManifest" xml:space="preserve">
|
||||||
|
<value>The manifest '{0}' was not found.</value>
|
||||||
|
</data>
|
||||||
|
<data name="Localization_MissingManifest_Parent" xml:space="preserve">
|
||||||
|
<value>No manifests exist for the current culture.</value>
|
||||||
|
</data>
|
||||||
|
</root>
|
||||||
|
|
@ -59,10 +59,60 @@ namespace Microsoft.Extensions.Localization.Tests
|
||||||
Assert.Equal(expectedCallCount, resourceAssembly2.GetManifestResourceStreamCallCount);
|
Assert.Equal(expectedCallCount, resourceAssembly2.GetManifestResourceStreamCallCount);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[InlineData(true)]
|
||||||
|
[InlineData(false)]
|
||||||
|
public void ResourceManagerStringLocalizer_GetAllStrings_ReturnsExpectedValue(bool includeParentCultures)
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var baseName = "test";
|
||||||
|
var resourceNamesCache = new ResourceNamesCache();
|
||||||
|
var resourceAssembly = new TestAssemblyWrapper();
|
||||||
|
var resourceManager = new TestResourceManager(baseName, resourceAssembly.Assembly);
|
||||||
|
var localizer = new ResourceManagerStringLocalizer(resourceManager, resourceAssembly, baseName, resourceNamesCache);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
// We have to access the result so it evaluates.
|
||||||
|
var strings = localizer.GetAllStrings(includeParentCultures).ToList();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
var value = Assert.Single(strings);
|
||||||
|
Assert.Equal("TestName", value.Value);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[InlineData(true)]
|
||||||
|
[InlineData(false)]
|
||||||
|
public void ResourceManagerStringLocalizer_GetAllStrings_MissingResourceThrows(bool includeParentCultures)
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var resourceNamesCache = new ResourceNamesCache();
|
||||||
|
var baseName = "testington";
|
||||||
|
var resourceAssembly = new TestAssemblyWrapper("Assembly1");
|
||||||
|
var resourceManager = new TestResourceManager(baseName, resourceAssembly.Assembly);
|
||||||
|
var localizer = new ResourceManagerWithCultureStringLocalizer(
|
||||||
|
resourceManager,
|
||||||
|
resourceAssembly.Assembly,
|
||||||
|
baseName,
|
||||||
|
resourceNamesCache,
|
||||||
|
CultureInfo.CurrentCulture);
|
||||||
|
|
||||||
|
// Act & Assert
|
||||||
|
var exception = Assert.Throws<MissingManifestResourceException>(() =>
|
||||||
|
{
|
||||||
|
// We have to access the result so it evaluates.
|
||||||
|
localizer.GetAllStrings(includeParentCultures).ToArray();
|
||||||
|
});
|
||||||
|
var expected = includeParentCultures
|
||||||
|
? "No manifests exist for the current culture."
|
||||||
|
: "The manifest 'testington.en-US.resources' was not found.";
|
||||||
|
Assert.Equal(expected, exception.Message);
|
||||||
|
}
|
||||||
|
|
||||||
private static Stream MakeResourceStream()
|
private static Stream MakeResourceStream()
|
||||||
{
|
{
|
||||||
var stream = new MemoryStream();
|
var stream = new MemoryStream();
|
||||||
var resourceWriter = new ResourceWriter(stream);
|
var resourceWriter = new ResourceWriter(stream);
|
||||||
resourceWriter.AddResource("TestName", "value");
|
resourceWriter.AddResource("TestName", "value");
|
||||||
resourceWriter.Generate();
|
resourceWriter.Generate();
|
||||||
stream.Position = 0;
|
stream.Position = 0;
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue