Missing the missing UseExtension

[drewburlingame]

We have several extension methods that help us format different types of output from our tests. For example, we use Verify to generate "freeze files" for our arch-unit tests to capture violations that need to be fixed but we can't take them on just yet. The freeze files have some specific conventions including using the extension "freeze.txt". In another case, we generate markdown reports describing aspects of our code and they use several settings together. Now that UseExtensions has been removed, the extension methods we use for formatting are missing a key aspect of the configuration and we have to correctly set the extension in all places the extension methods are used. Any chance we could bring this feature back?

[SimonCropp]

can u share some runnable examples of your scenarios? perhaps push them up to a gh repo with the solution working against the older version of Verify

[drewburlingame]

Apologies for the delayed response. I don't have runnable examples, but I think this will give you the concept. We have these extension methods that we use to generate various types of reports on our code base.

public static class VerifySettingsExtensions
{
    public static SettingsTask AsFreezeFile(this SettingsTask settings) =>
        settings.UseExtension("freeze.txt");

    public static SettingsTask AsMarkdownReport(this SettingsTask settings) => 
        settings.UseExtension("md").AutoVerify(includeBuildServer: false);
    
    public static VerifySettings AsFreezeFile(this VerifySettings settings)
    {
        settings.UseExtension("freeze.txt");
        return settings;
    }

    public static VerifySettings AsMarkdownReport(this VerifySettings settings)
    {
        settings.UseExtension("md");
        settings.AutoVerify(includeBuildServer: false);
        return settings;
    }
}

and example use cases

    [Test]
    public async Task PermissionsMarkdownReport() =>
        await Verify(BuildPermissionsReport()).AsMarkdownReport();

    [Test]
    public async Task EfCore_entities_must_have_tenant_attribute() => 
        await Verify(MissingTenantAttribute(EntityTypes).Select(t => t.Name))
            .AsFreezeFile();

Does this give you enough context?

[drewburlingame]

@SimonCropp just checking in. Were these examples enough to give you the context of what we're looking for? If not, I'll carve out some time to put up a repo for you. Was hoping to save us both some time if this was enough.

[SeanFeldman]

Same here. The code used to verify image types with the output filenames constructed using the extension of the input type.

 public static IEnumerable<object[]> ImageTypePermutations()
{
            yield return new object[] { "jpeg", new JpegEncoder(), "image/jpeg"};
            yield return new object[] { "png", new PngEncoder(), "image/png"};
            yield return new object[] { "gif", new PngEncoder(), "image/gif"};
}

With UseExtension() gone, the output that's generated is all .bin

[SeanFeldman]

The fix is now to supply the extension in the Verify() call as an optional parameter.

await Verify(stream, extension: imageExtension)

In case you'll be reviewing the API, @SimonCropp, this is less intuitive than an extension method with a fluent API or VerifySettings parameter passed into Verify().