Verify Snapshot Testing

Verify provides a wide range of plugins to extend its capabilities for specific technologies, file formats, and UI frameworks. Common categories include:

• Web & UI: Verify.AspNetCore, Verify.Blazor, Verify.Bunit, Verify.Avalonia, Verify.WinForms, Verify.Xamarin, Verify.Xaml, and Verify.HeadlessBrowsers (supporting Playwright, Puppeteer Sharp, or Selenium).
• Documents & Data: Verify.Aspose (pdf, docx, xlsx, pptx), Verify.ClosedXml (Excel), Verify.CsvHelper (CSV), Verify.OpenXml (Excel), Verify.PdfPig (pdf), Verify.QuestPDF (pdf), and Verify.Yaml.
• Databases: Verify.Cosmos (Azure CosmosDB), Verify.MongoDB, Verify.RavenDb, and Verify.SqlServer.
• JSON & Serialization: Verify.NewtonsoftJson, Verify.SystemJson, and Verify.Yaml.
• Logging & Diagnostics: Verify.MicrosoftLogging, Verify.Serilog, Verify.OpenTelemetry, and Verify.Diagnostics.
• Mocking & Testing Frameworks: Verify.Moq, Verify.NSubstitute, Verify.FakeItEasy, and Verify.MassTransit.
• Images: Verify.ImageSharp, Verify.ImageMagick, Verify.ImageHash, and Verify.Phash.

Check the official plugin list for the full enumeration of supported integrations.

Because Fixie is less opinionated, you must manually configure the test project lifecycle to enable Verify. You need to implement ITestProject and IExecution interfaces.

Requirements:

1. In ITestProject.Configure, assign the target assembly using VerifierSettings.AssignTargetAssembly(environment.Assembly).
2. In IExecution.Run, wrap test executions using ExecutionState.Set(testClass, test, parameters) to ensure Verify can correctly identify the context of the failing test.

public class TestProject :
    ITestProject,
    IExecution
{
    public void Configure(TestConfiguration configuration, TestEnvironment environment)
    {
        VerifierSettings.AssignTargetAssembly(environment.Assembly);
        configuration.Conventions.Add<DefaultDiscovery, TestProject>();
    }

    public async Task Run(TestSuite testSuite)
    {
        foreach (var testClass in testSuite.TestClasses)
        {
            foreach (var test in testClass.Tests)
            {
                if (test.HasParameters)
                {
                    foreach (var parameters in test
                                 .GetAll<TestCase>()
                                 .Select(_ => _.Parameters))
                    {
                        using (ExecutionState.Set(testClass, test, parameters))
                        {
                            await test.Run(parameters);
                        }
                    }
                }
                else
                {
                    using (ExecutionState.Set(testClass, test, null))
                    {
                        await test.Run();
                    }
                }
            }
        }
    }
}

To ensure that .received files are available for inspection when tests fail in an Azure DevOps pipeline, you must set a flag during a failed test runner step, stage the files using CopyFiles@2, and then publish them using PublishBuildArtifacts@1. This is necessary because PublishBuildArtifacts@1 does not support wildcards directly.

Follow these steps in your YAML pipeline:

1. Set a failure flag: Immediately after your test runner step, add a CmdLine@2 task that runs only if the previous step failed to set the publishverify variable.
2. Stage the files: Use CopyFiles@2 to move all **/*.received.* files to the $(Build.ArtifactStagingDirectory)/Verify folder.
3. Publish the artifacts: Use PublishBuildArtifacts@1 to publish the staged folder as an artifact named Verify.

- task: CmdLine@2
  displayName: 'Set flag to publish Verify *.received.* files when test step fails'
  condition: failed()
  inputs:
    script: 'echo "##vso[task.setvariable variable=publishverify]Yes"'

- task: CopyFiles@2
  condition: eq(variables['publishverify'], 'Yes')
  displayName: 'Copy Verify *.received.* files to Artifact Staging'
  inputs:
    contents: '**/*.received.*' 
    targetFolder: '$(Build.ArtifactStagingDirectory)/Verify'
    cleanTargetFolder: true
    overWrite: true

- task: PublishBuildArtifacts@1
  displayName: 'Publish Verify *.received.* files as Artifacts'
  name: 'verifypublish'
  condition: eq(variables['publishverify'], 'Yes')
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)/Verify'
    ArtifactName: 'Verify'
    publishLocation: 'Container'