leverage Verify.SystemJson to support verify for JsonNode

[SimonCropp]

Description

• Add Verify.SystemJson. This unlocks passing JsonNode instances to Verify()
• enable VerifierSettings.UseStrictJson(); https://github.com/VerifyTests/Verify/blob/main/docs/serializer-settings.md#not-valid-json . this seems to be the preference for the code base? let me know if it isnt
• Add VerifierSettings.InitializePlugins. this enables any plugins for Verify, in this case only Verify.SystemJson

Checklist

• Is this feature complete?
  • Yes. Ready to ship.
  • No. Follow-up changes expected.
• Are you including unit tests for the changes and scenario tests if relevant?
  • Yes
  • No
• Did you add public API?
  • Yes
    • If yes, did you have an API Review for it?
      • Yes
      • No
    • Did you add <remarks /> and <code /> elements on your triple slash comments?
      • Yes
      • No
  • No
• Does the change make any security assumptions or guarantees?
  • Yes
    • If yes, have you done a threat model and had a security review?
      • Yes
      • No
  • No
• Does the change require an update in our Aspire docs?
  • Yes
    • Link to aspire-docs issue (consider using one of the following templates):
      • New (or update) doc-idea template
      • New breaking-change template
      • New diagnostic template
  • No

[Copilot]

Pull Request Overview

This PR introduces support for verifying JsonNode instances by leveraging the new Verify.SystemJson package and updating test verification calls. Key changes include:

• Adding VerifierSettings.UseStrictJson() and VerifierSettings.InitializePlugins() during test initialization.
• Updating project files to include the Verify.SystemJson package.
• Replacing calls to Verify(manifest.ToString(), "json") with Verify(manifest) in tests.

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 6 comments.

File	Description
tests/Shared/TestModuleInitializer.cs	Added configuration calls for strict JSON and plugin initialization.
tests/Directory.Packages.props	Added Verify.SystemJson package reference.
tests/Aspire.Hosting.Kubernetes.Tests/*.csproj	Added package references for Verify.SystemJson.
tests/Aspire.Hosting.Azure.Tests/*.cs	Updated verification calls to pass JsonNode directly.

[SimonCropp]

can someone unlock the Verify.SystemJson nuget usage

[eerhardt]

can someone unlock the Verify.SystemJson nuget usage

I've kicked off the package mirror. When it is done I will re-kick this PR.

[eerhardt]

Looks like this is causing \" to be replaced with \u0022

Received: ExistingAzureResourceTests.SupportsExistingAzureSqlServerWithResourceGroup.received.json
{
  "type": "azure.bicep.v1",
  "connectionString": "Server=tcp:{sqlServer.outputs.sqlServerFqdn},1433;Encrypt=True;Authentication=\"Active Directory Default\"",
  "path": "sqlServer.module.bicep",
  "params": {
    "existingResourceName": "{existingResourceName.value}"
  },
  "scope": {
    "resourceGroup": "{existingResourceGroupName.value}"
  }
}
Verified: ExistingAzureResourceTests.SupportsExistingAzureSqlServerWithResourceGroup.verified.json
{
  "type": "azure.bicep.v1",
  "connectionString": "Server=tcp:{sqlServer.outputs.sqlServerFqdn},1433;Encrypt=True;Authentication=\u0022Active Directory Default\u0022",
  "path": "sqlServer.module.bicep",
  "params": {
    "existingResourceName": "{existingResourceName.value}"
  },
  "scope": {
    "resourceGroup": "{existingResourceGroupName.value}"
  }
}
``

[SimonCropp]

@eerhardt

it is the other way around causing \u0022 to be replaced with \"

would you like to keep \u0022? if so i can look at how to enable that.

if u r ok with \" i will accept the changes and update the PR

[SimonCropp]

actually. i will put this in draft for now. let me have think on it

[SimonCropp]

@eerhardt i look into this

the building of that portion of the string is done by AzureSqlServerResource

return result ??
                ReferenceExpression.Create($"Server=tcp:{FullyQualifiedDomainName},1433;Encrypt=True;Authentication=\"Active Directory Default\"");

the reason this \u0022 ends up in the json is because of the default serialization behaviour

https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/character-encoding#serialize-language-character-sets

So in ManifestPublishingContext.WriteConnectionString

public void WriteConnectionString(IResource resource)
{
    if (resource is IResourceWithConnectionString resourceWithConnectionString &&
        resourceWithConnectionString.ConnectionStringExpression is { } connectionString)
    {
        Writer.WriteString("connectionString", connectionString.ValueExpression);
    }
}

the writer has no encoder config so we get \u0022

Test showing the behavior

[Test]
public void EncodingTest()
{
    var value = new
    {
        value = "\""
    };
    json = JsonSerializer.Serialize(value);
    ClassicAssert.AreEqual(
        """
        {
          "value": "\u0022"
        }
        """,
        json);
}

to get a non-unicode escaped quote we would need to use an Encoder

[Test]
public void EncodingWithRelaxedTest()
{
    var options = new JsonSerializerOptions
    {
        Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
        WriteIndented = true
    };
    var value = new
    {
        value = "\""
    };
    json = JsonSerializer.Serialize(value, options);
    ClassicAssert.AreEqual(
        """
        {
          "value": "\""
        }
        """,
        json);
}

The reason verified file change from \u0022 to \" is that Verify.SystemJson round trips the json to support Scrubbering. And when those encoded values are read using System.Text.Json then it gives back the un-encoded quote. When verify writes it, it uses the raw value it received. ie it escapes but doesnt encode

so IMO having the verified file change from \u0022 to \" is actually more correct.

I am not sure how u want to proceed here. I would prefer manifests are written to disk with the more readable \", but i dont know larger implications of that

The value of this is, aside from less code, that Verify.SystemJson supports the larger feature set of Verify. I am not sure of the encoding qwerk is a problem (that dilutes that value) or not?

thoughts?

[eerhardt]

I'm fine with the \u0022 getting changed to \". I just wanted to make sure it was a conscious change and not a mistake.