[s390x] Fix Extensions.ApiDescription.Client tests on s390x

[saitama951]

Extensions.ApiDescription client tests cases were failing on s390x

Microsoft.Extensions.ApiDescription.Client.GetOpenApiReferenceMetadataTest.Execute_SetsClassName_BasedOnSanitizedOutputPath(outputPath: "aabb.cs", className: "aa__bb") [FAIL]
[xUnit.net 00:00:00.54]       Assert.Equal() Failure: Collections differ
[xUnit.net 00:00:00.54]       Expected: [["ClassName"] = "aa__bb", ["CodeGenerator"] = "NSwagCSharp", ["FirstForGenerator"] = "true", ["Namespace"] = "Console.Client", ["OriginalItemSpec"] = "TestProjects/files/NSwag.json", ···]
[xUnit.net 00:00:00.54]       Actual:   [["ClassName"] = "aa__bb", ["CodeGenerator"] = "NSwagCSharp", ["FirstForGenerator"] = "true", ["Namespace"] = "Console.Client", ["OriginalItemSpec"] = "TestProjects/files/NSwag.json", ···]
[xUnit.net 00:00:00.54]       Stack Trace:
[xUnit.net 00:00:00.54]         /home/sanjam/aspnetcore/src/Tools/Extensions.ApiDescription.Client/test/GetOpenApiReferenceMetadataTest.cs(450,0): at Microsoft.Extensions.ApiDescription.Client.GetOpenApiReferenceMetadataTest.Execute_SetsClassName_BasedOnSanitizedOutputPath(String outputPath, String className)
[xUnit.net 00:00:00.54]            at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args)
[xUnit.net 00:00:00.54]            at System.Reflection.MethodBaseInvoker.InvokeDirectByRefWithFewArgs(Object obj, Span`1 copyOfArgs, BindingFlags invokeAttr)
[xUnit.net 00:00:00.54]    

according to the msdocs

For purposes of enumeration, each item in the dictionary is treated as a [KeyValuePair<TKey,TValue>](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.keyvaluepair-2?view=net-8.0) structure representing a value and its key. The order in which the items are returned is undefined.

This is just a snippet of a particular failure, I have attached the other failures as well
Untitled.txt

[captainsafia]

according to the msdocs

Can you provide a link to the docs you're referencing here?

[saitama951]

according to the msdocs

Can you provide a link to the docs you're referencing here?

Sure . https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2?view=net-8.0#remarks

[dotnet-policy-service]

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

[captainsafia]

It's not clear to me why we need to make this mutation to the SerializedMetadata field on S390X targets. Can you provide an example of what the current metadata output looks like? The logs you shared appear to be truncated and don't show the actual comparison of the SerializedMetadata field.

[saitama951]

According to my understanding, This might be due to when serializing metadata

aspnetcore/src/Tools/Extensions.ApiDescription.Client/src/MetadataSerializer.cs

Line 74 in 20743f2

var metadata = item.CloneCustomMetadata();

where CloneCustomMetadata usually returns an Dictionary where the order might be undefined.

Here is the difference in this particular test case on s390x

Expected: [ClassName, NSwagClient][CodeGenerator, NSwagCSharp][FirstForGenerator, true][Namespace, Console.Client][OriginalItemSpec, TestProjects/files/NSwag.json][OutputPath, obj/NSwagClient.cs][SerializedMetadata, Identity=TestProjects/files/NSwag.json|FirstForGenerator=true|CodeGenerator=NSwagCSharp|OutputPath=obj/NSwagClient.cs|Namespace=Console.Client|OriginalItemSpec=TestProjects/files/NSwag.json|ClassName=NSwagClient]
--------------------------------------------------------------------------------------------
Actual: [ClassName, NSwagClient][CodeGenerator, NSwagCSharp][FirstForGenerator, true][Namespace, Console.Client][OriginalItemSpec, TestProjects/files/NSwag.json][OutputPath, obj/NSwagClient.cs][SerializedMetadata, Identity=TestProjects/files/NSwag.json|FirstForGenerator=true|Namespace=Console.Client|OriginalItemSpec=TestProjects/files/NSwag.json|ClassName=NSwagClient|OutputPath=obj/NSwagClient.cs|CodeGenerator=NSwagCSharp]

Note this change in order is not only wrt architecture but with runtime's as well.
here is the change in order for x64 mono

expected: [ClassName, NSwagClient][CodeGenerator, NSwagCSharp][FirstForGenerator, true][Namespace, Console.Client][OriginalItemSpec, TestProjects/files/NSwag.json][OutputPath, obj/NSwagClient.cs][SerializedMetadata, Identity=TestProjects/files/NSwag.json|FirstForGenerator=true|CodeGenerator=NSwagCSharp|OutputPath=obj/NSwagClient.cs|Namespace=Console.Client|OriginalItemSpec=TestProjects/files/NSwag.json|ClassName=NSwagClient]
--------------------------------------------------------------------------------------------
Actual: [ClassName, NSwagClient][CodeGenerator, NSwagCSharp][FirstForGenerator, true][Namespace, Console.Client][OriginalItemSpec, TestProjects/files/NSwag.json][OutputPath, obj/NSwagClient.cs][SerializedMetadata, Identity=TestProjects/files/NSwag.json|CodeGenerator=NSwagCSharp|OriginalItemSpec=TestProjects/files/NSwag.json|FirstForGenerator=true|OutputPath=obj/NSwagClient.cs|ClassName=NSwagClient|Namespace=Console.Client]

[saitama951]

@captainsafia can we reopen this PR?

[akoeplinger]

the change makes sense to me, maybe we could add a little helper method to do the reordering so we don't have all the repetitive code?

[dotnet-policy-service]

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

[akoeplinger]

I was asked to reopen this so here you go.

[dotnet-policy-service]

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.