Reporting to Extent Reports

How to configure Atata reporting to Extent Reports.

Packages

In addition to Atata package, the ExtentReports package should be added to the project. It is also recommended to add NLog package, as it’s used in the sample project.

Implementation

The functionality for Extent Reports is implemented in 4 class files:

ExtentContext.cs - the main static class responsible for an initialization of Extent Reports. In this sample it attaches HTML reporter (ExtentHtmlReporter). Saves HTML report to AtataContext Artifacts root directory. Other Extent reporters can also be attached.
ExtentLogConsumer.cs - is responsible for reporting of log messages. Also does formatting of message.
ExtentArtifactAddedEventHandler.cs - is responsible for screenshots adding to report.
AddArtifactsToExtentReportEventHandler.cs - adds “Artifacts” markup to test reports.

You can copy all those files to your project and modify according to your project’s needs.

Later a separate Atata.ExtentReports NuGet package is planned to be published.

Configuration

In order to connect Extent Reports functionality to Atata, ExtentLogConsumer, ExtentArtifactAddedEventHandler and AddArtifactsToExtentReportEventHandler should be added to AtataContextBuilder.

SetUpFixture

ExtentArtifactAddedEventHandler can be added to EventSubscriptions in SetUpFixture.
To perform a generation of report file, ExtentContext.Reports.Flush() method should be executed as a final action of a tests run. In NUnit a good place for it is OneTimeTearDown method of SetUpFixture.cs.

SetUpFixture.cs

using Atata;
using Atata.ExtentReports;
using NUnit.Framework;

namespace AtataSamples.ExtentReports;

[SetUpFixture]
public class SetUpFixture
{
    [OneTimeSetUp]
    public void GlobalSetUp()
    {
        AtataContext.GlobalConfiguration
            .UseChrome()
                .WithArguments("headless=new", "window-size=1024,768")
            .UseBaseUrl("https://demo.atata.io/")
            .UseCulture("en-US")
            .UseAllNUnitFeatures()
            .LogConsumers.AddNLogFile()
            .ScreenshotConsumers.AddFile()
            .EventSubscriptions.Add(new ExtentArtifactAddedEventHandler());

        AtataContext.GlobalConfiguration.AutoSetUpDriverToUse();
    }

    [OneTimeTearDown]
    public void GlobalTearDown() =>
        ExtentContext.Reports.Flush();
}

UITestFixture

UITestFixture is often used as a base UI test fixture class. For this sample the implementation is more complicated as usual, because additionally AtataContext for fixture is also added.

UITestFixture.cs

using Atata;
using Atata.ExtentReports;
using NUnit.Framework;
using NUnit.Framework.Internal;

namespace AtataSamples.ExtentReports;

[TestFixture]
[Parallelizable(ParallelScope.Fixtures)]
public class UITestFixture
{
    protected AtataContext FixtureContext { get; set; }

    protected virtual bool UseFixtureDriverForTests => false;

    [OneTimeSetUp]
    public void InitFixtureContext() =>
        FixtureContext = AtataContext.Configure()
            .UseDriverInitializationStage(AtataContextDriverInitializationStage.OnDemand)
            .LogConsumers.Add<ExtentLogConsumer>()
                .WithMinLevel(LogLevel.Warn)
            .Build();

    [OneTimeTearDown]
    public void DisposeFixtureContext() =>
        FixtureContext?.Dispose();

    [SetUp]
    public void SetUp()
    {
        var testContextBuilder = AtataContext.Configure()
            .LogConsumers.Add<ExtentLogConsumer>()
                .WithMinLevel(LogLevel.Info)
                .WithSectionEnd(LogSectionEndOption.IncludeForBlocks)
            .EventSubscriptions.Add(new AddArtifactsToExtentReportEventHandler());

        if (UseFixtureDriverForTests)
            testContextBuilder
                .UseDriver(FixtureContext.Driver)
                .UseDisposeDriver(false);

        testContextBuilder.Build();
    }

    [TearDown]
    public void TearDown() =>
        AtataContext.Current?.Dispose();
}

Tests

Tests Using Own Drivers

UsingOwnDriverTests.cs

using Atata;
using NUnit.Framework;

namespace AtataSamples.ExtentReports;

public class UsingOwnDriverTests : UITestFixture
{
    [Test]
    public void Test1() =>
        Go.To<HomePage>()
            .Report.Screenshot()
            .Header.Should.Contain("Atata");

    [Test]
    public void Test2() =>
        Go.To<HomePage>()
            .Report.Screenshot()
            .AggregateAssert(x => x
                .PageTitle.Should.Contain("Atata")
                .Header.Should.Contain("Atata"));
}

For testing purposes, screenshots are captured right after a navigation to the home page. Also when the test fails at any moment, a screenshot is captured as well.

Tests Reusing Driver

In this test fixture class we create one shared driver for all class tests, do navigation once in SetUpFixture method, then every test starts with already navigated page and does its verification.

using Atata;
using NUnit.Framework;

namespace AtataSamples.ExtentReports;

public class UsingSameDriverTests : UITestFixture
{
    protected override bool UseFixtureDriverForTests => true;

    [OneTimeSetUp]
    public void SetUpFixture() =>
        Go.To<SignInPage>();

    [Test]
    public void Email() =>
        Go.On<SignInPage>()
            .Email.Should.BeVisible();

    [Test]
    public void Password() =>
        Go.On<SignInPage>()
            .Password.Should.BeVisible();
}

Results

After a tests run, the generated Extent HTML report can be found by relative path: \AtataSamples.ExtentReports\bin\Debug\net6.0\artifacts\{DATETIME_OF_RUN}\Report.html.

Extent Report