Tests are failing because of namespace order

[janis-veinbergs]

Hello.
Cloned solution, opened in VS2022 - build succeeds.
Running tests gets you reds all over

For example, BooleanRemove complains:

    Assert.AreEqual failed. Expected:<<entities xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><entity name="knowledgearticle" displayname="Knowledge Article"><records><record id="f835a513-ed9e-e711-9401-0003ff66fbff"><field name="expirationstateid" value="3" /><field name="knowledgearticleid" value="f835a513-ed9e-e711-9401-0003ff66fbff" /></record></records><m2mrelationships /></entity></entities>>. Actual:<<entities xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><entity name="knowledgearticle" displayname="Knowledge Article"><records><record id="f835a513-ed9e-e711-9401-0003ff66fbff"><field name="expirationstateid" value="3" /><field name="knowledgearticleid" value="f835a513-ed9e-e711-9401-0003ff66fbff" /></record></records><m2mrelationships /></entity></entities>>. 

Notice the namespace order is different

I don't know what causes this undeterministic behavior... would it be OK if I make PR which "normalizes" xml before comparison in a way that it sorts namespaces?

Another option would be custom XmlWriter https://stackoverflow.com/questions/20701750/c-sharp-xml-serialization-order-of-namespace-declarations

I tried to tinker with code but I don't know how to influence serializing namespace order. Moreover I tried the said stackoverflow serializer and the result was the namespaces were not sorted but gone.

[abvogel]

Thanks @janis-veinbergs - I'm not sure why the order would be different from your clone. I'll have to take a look. I tried in the assert to have it match character for character against what the Data Exporter generates, so I'd prefer to keep the order if possible. I know theoretically it shouldn't matter, but sometimes code is more arbitrary than robust...

[janis-veinbergs]

Tried VS2019:

92 Passed
26 Failed

vs VS2022:

45 Passed
73 Failed

Other failures like:

   Duration: < 1 ms

  Message: 
Test method Microsoft.Xrm.DevOps.Data.Tests.SchemaImports.MoneyType threw exception: 
System.FormatException: Input string was not in a correct format.

  Stack Trace: 
Number.StringToNumber(String str, NumberStyles options, NumberBuffer& number, NumberFormatInfo info, Boolean parseDecimal)
Number.ParseDecimal(String value, NumberStyles options, NumberFormatInfo numfmt)
Decimal.Parse(String s)
XmlImporter.GetObjectFromFieldNodeType(Field field, Entity schemaData) line 40
DataBuilder.AppendData(Entities DataXML, Entities SchemaXML) line 167
DataBuilder.AppendData(XmlDocument DataXML, XmlDocument SchemaXML) line 144
DataBuilder.AppendData(String DataXML, String SchemaXML) line 131
SchemaImports.MoneyType() line 107

And

  Message: 
Test method Microsoft.Xrm.DevOps.Data.Tests.Configurations.MultipleSourcesOfMetadata_SchemaImported threw exception: 
System.FormatException: String was not recognized as a valid DateTime.

  Stack Trace: 
DateTimeParse.Parse(String s, DateTimeFormatInfo dtfi, DateTimeStyles styles)
DateTime.Parse(String s)
XmlImporter.GetObjectFromFieldNodeType(Field field, Entity schemaData) line 30
DataBuilder.AppendData(Entities DataXML, Entities SchemaXML) line 167
DataBuilder.AppendData(XmlDocument DataXML, XmlDocument SchemaXML) line 144
DataBuilder.AppendData(String DataXML, String SchemaXML) line 131
Configurations.MultipleSourcesOfMetadata_SchemaImported() line 616

This is another issue, seems to be related to regional settings as it related to datetime,money,decimal tests.

However namespace issues are gone on VS2019

VS2019 uses: C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\MSBuild\Current\Bin\Roslyn\csc.exe
VS2022: uses C:\Program Files\Microsoft Visual Studio\2022\Professional\MSBuild\Current\Bin\Roslyn\csc.exe

[janis-veinbergs]

I found out it is not issue with the build, but with the test runner. Because even if I compile with v16 toolchain and if test runner is v17 (2022) it gets wrong namespace ordering.

The version on the left succeeded the build but failed the test.
The version on the right succeeded the build and the test.

Updated to latest VS 17.8.5 and still the same deal.

[janis-veinbergs]

It boils down to Platform. I tried running tests manually against built.dll: vstest.console.exe for 2022 (v17) is within normal program files folder and for 2019 (v16) in x86 - i thought maybe that is the case.

Sure enough - manually specifying /Platform results in:

• v16 and v17 failing on x64
• v16 and v17 succeeding on x86

Within UI one can set platform like this:

When I chose x86 it also now works in VS2022 test runner.

I now that I know what to search for, I found prior work to this issue... 12+ years ago:
Inconsistent Namespace Order using XmlSerializer on x86/x64 RRS feed

A quick'n'dirty workaround is to specify .runsettings file which specifies to run in x86 platform mode and add the following property to test .csproj file:

<RunSettingsFilePath>$(MSBuildProjectDirectory)\.runsettings</RunSettingsFilePath>

So no manual steps are involved for users working on this code.