Restore write-resource-to-text tests #4830

rainersigwald · 2019-10-18T15:21:33Z

Closes #308 by re-enabling the tests.

Closes dotnet#308 by re-enabling the tests.

rainersigwald · 2019-10-18T15:40:58Z

I thought this worked on my machine but I was testing desktop framework. Sigh. Pulling for now.

This was working for ResXResourceReader-based resources but not the new reader.

There are various failures possible in ReadResources, but the existing test applies only to full framework

Uses the existing category from Xunit.NetCore.Extensions

These situations logged confusing English-only errors; now they fail and the error can get localized.

Forgind

Looks good to me. I had just a few questions.

Forgind · 2019-10-23T15:23:41Z

src/Tasks/GenerateResource.cs

@@ -2988,7 +2994,7 @@ private void ReadResources(String filename, bool shouldUseSourcePath, String out
 #if FEATURE_ASSEMBLY_LOADFROM
                ReadAssemblyResources(filename, outFileOrDir);
 #else
-                _logger.LogError("Reading resources from Assembly not supported on .NET Core MSBuild");
+                throw new InputFormatNotSupportedException("Reading resources from Assembly not supported on .NET Core MSBuild");


Why is it advantageous to throw instead of just logging an error? Are you trying to reduce duplicate output?

Logging an error here is nonfatal, so the experience with going through this codepath was:

This error.

Some other odd output when trying to move on.

Another fatal error that didn't directly indicate the problem.

Since there were already exception-based error paths in ProcessFile I opted to add another rather than change everything to error returns.

Forgind · 2019-10-23T15:27:19Z

src/Tasks/GenerateResource.cs

                {
+                    if (assemblyName == null)


Why would they be null?

That's what happens if an assembly name can't be extracted from a reference for some reason in PopulateAssemblyNames(). The other codepaths were robust to this situation but this newly-added one wasn't (until running a test revealed the error).

Forgind · 2019-10-23T15:30:44Z

src/Tasks/ResourceHandling/InputFormatNotSupportedException.cs

+namespace Microsoft.Build.Tasks.ResourceHandling
+{
+    [Serializable]
+    internal class InputFormatNotSupportedException : Exception


Is there a reason you can't use FormatException or ArgumentException instead of making your own (empty) new type of exception?

Having a custom exception type makes detecting this error condition easy using a catch-specific-type block.

Tracing how it's currently caught, I believe a FormatException will still have the exact same effect.

Also, I don't see anywhere that you try to catch it; do you have plans for adding something like that in the future? If not, you're breaking something that could otherwise be caught by an ArgumentException, failing more cleanly.

I believe a FormatException will still have the exact same effect.

Since it's a standard exception type, other code could insert a FormatException that would then be inadvertently caught and handled as this specific problem, rather than handled at another layer.

Also, I don't see anywhere that you try to catch it

https://github.com/microsoft/msbuild/pull/4830/files#diff-1d2aacce8c88cda3235c1659ea67e164R2606-R2611

If not, you're breaking something that could otherwise be caught by an ArgumentException, failing more cleanly.

This is harder to distinguish since other places could throw ArgumentException inside the big ProcessFile catch block.

Forgind · 2019-10-23T15:32:37Z

src/Tasks/Resources/xlf/Strings.es.xlf

@@ -979,6 +979,11 @@
        <target state="translated">MSB3190: ClickOnce no admite el nivel de ejecución de solicitudes '{0}'.</target>
        <note>{StrBegin="MSB3190: "}</note>
      </trans-unit>
+      <trans-unit id="GenerateResource.CoreSupportsLimitedScenarios">
+        <source>MSB3824: In order to build with .NET Core, resource inputs must be in .txt or .resx format.</source>


I'm guessing this is supposed to be a localized version. When does that happen?

Correct. The loc team periodically (at least once per minor release) does a pass on strings and will submit a PR with updated localizations (#4679 was a recent one). Until that's done the English copy of the string is used.

Docs are here: https://github.com/microsoft/msbuild/blob/master/documentation/wiki/Localization.md

benvillalobos · 2019-10-23T19:41:06Z

src/Tasks.UnitTests/ResourceHandling/GenerateResource_Tests.cs

+                if (string.IsNullOrEmpty(resgenFile))
+                {
+                        resgenFile = GetTempFileName(".resx");
+                        File.Delete(resgenFile);


(nit) Is this line necessary? According to the File.WriteAllText documentation, even if the file did exist it would be overwritten

It's preexisting but no, I don't think it is. I'll remove.

rainersigwald · 2019-10-23T20:47:57Z

/azp run

azure-pipelines · 2019-10-23T20:48:07Z

Azure Pipelines successfully started running 1 pipeline(s).

Restore write-resource-to-text tests

9aa42bb

Closes dotnet#308 by re-enabling the tests.

rainersigwald added CoreCLR-test Disabled-Tests labels Oct 18, 2019

rainersigwald added this to the MSBuild 16.4 milestone Oct 18, 2019

rainersigwald closed this Oct 18, 2019

rainersigwald added 4 commits October 18, 2019 13:46

Disable InvalidReference test on Core

86c74a5

Error when serializing resources to text

3a6da3e

This was working for ResXResourceReader-based resources but not the new reader.

Support TestEnvironment in resx tests

a89802a

Failure-to-read-resources test is desktop only

bc04a15

There are various failures possible in ReadResources, but the existing test applies only to full framework

rainersigwald reopened this Oct 21, 2019

rainersigwald added 2 commits October 21, 2019 16:33

Allow core-only tests

1de44ef

Uses the existing category from Xunit.NetCore.Extensions

Localized error for can't-read-that-from-Core

60f260c

These situations logged confusing English-only errors; now they fail and the error can get localized.

rainersigwald force-pushed the fix-308 branch from af395fb to 60f260c Compare October 21, 2019 21:33

Forgind approved these changes Oct 23, 2019

View reviewed changes

benvillalobos reviewed Oct 23, 2019

View reviewed changes

Remove redundant delete in WriteTestResX

2c99582

benvillalobos approved these changes Oct 23, 2019

View reviewed changes

rainersigwald merged commit 455f5be into dotnet:master Oct 24, 2019

rainersigwald deleted the fix-308 branch October 24, 2019 15:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restore write-resource-to-text tests #4830

Restore write-resource-to-text tests #4830

rainersigwald commented Oct 18, 2019

rainersigwald commented Oct 18, 2019

Forgind left a comment

Forgind Oct 23, 2019

rainersigwald Oct 23, 2019

Forgind Oct 23, 2019

rainersigwald Oct 23, 2019

Forgind Oct 23, 2019

rainersigwald Oct 23, 2019

Forgind Oct 23, 2019

rainersigwald Oct 23, 2019

Forgind Oct 23, 2019

rainersigwald Oct 23, 2019

benvillalobos Oct 23, 2019

rainersigwald Oct 23, 2019

rainersigwald commented Oct 23, 2019

azure-pipelines bot commented Oct 23, 2019

Restore write-resource-to-text tests #4830

Restore write-resource-to-text tests #4830

Conversation

rainersigwald commented Oct 18, 2019

rainersigwald commented Oct 18, 2019

Forgind left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rainersigwald commented Oct 23, 2019

azure-pipelines bot commented Oct 23, 2019