Upgrade to Atata 3

How to upgrade to Atata 3 considering breaking changes.

First steps

The first migration step is to ensure or upgrade your Atata to v2.14.1. Then fix all Atata warnings telling that some class/member is obsolete, as those items should be removed in v3.

You can also take a look at Atata Framework 3 is Released blog post to find out what’s new in v3.

New AtataContext.GlobalProperties

Some of the AtataContext properties and AtataContextBuilder methods were moved to the new AtataContext.GlobalProperties static property. Global properties can be set once before any AtataContext creation (in global setup method), and those properties spread all over the AtataContexts.

Check the list of related issues for details:

• #822 Extract Artifacts Root path out of Artifacts path
• #823 Move TimeZone instance property of AtataContext to AtataContext.GlobalProperties
• #824 Move BuildStart and BuildStartUtc static properties of AtataContext to AtataContext.GlobalProperties
• #825 Move ModeOfCurrent static property of AtataContext to AtataContext.GlobalProperties

Screenshot consumers functionality is removed

Screenshots functionality is simplified and now its configuration is similar to the configuration of page snapshots. Basically, you no longer need to call ScreenshotConsumers.AddFile() to enable screenshots saving, it is enabled by default. To change the default screenshot file path template use Screenshots.UseFileNameTemplate("...").

Removed

• AtataContextBuilder’s ScreenshotConsumers property is removed together with all the other code related to it.
• The same is valid for JSON configuration, “screenshotConsumers” JSON property is gone. Use "screenshots"/"fileNameTemplate" JSON property to configure screenshot file path.
• IScreenshotConsumer and implementation classes are removed.

Replaced file path configuration of NLogFileConsumer with single WithFileNameTemplate method

Added NLogFileConsumer property:

/// <summary>
/// Gets or sets the file name template.
/// The default value is <c>"Trace.log"</c>.
/// </summary>
public string FileNameTemplate { get; set; }

Removed NLogFileConsumer properties:

• DirectoryPathBuilder
• FileNameBuilder
• FilePathBuilder

Added LogConsumerAtataContextBuilder<NLogFileConsumer> configuration extension method:

public static LogConsumerAtataContextBuilder<NLogFileConsumer> WithFileNameTemplate(
    this LogConsumerAtataContextBuilder<NLogFileConsumer> builder,
    string fileNameTemplate)

Removed LogConsumerAtataContextBuilder<NLogFileConsumer> configuration extension methods:

• WithArtifactsDirectoryPath
• WithDirectoryPath
• WithFilePath
• WithFileName

[FindByAlt] attribute is set as default for Image<TOwner> control

Sets the default search strategy by alt attribute. Before, by default [FindFirst] was applied.

Update sanitization approach of TestInfo properties NameSanitized and SuiteNameSanitized

Before v3, invalid characters were just removed from a string. Now they are replaced with underscore symbol, similarly to sanitization of screenshot and snapshot file names. This mainly affects the test folder names in Artifacts directory path.

For example:
Test("2/1") as Name becomes
Test(_2_1_) as NameSanitized

All breaking changes

• minor #808 Remove obsolete types and members related to UIComponent
• minor #809 Remove obsolete logging/reporting members
• minor #810 Remove obsolete event handler types
• minor #811 Remove obsolete AtataContextBuilder methods
• minor #812 Remove obsolete AtataContext members
• minor #813 Remove obsolete attributes
• minor #814 Remove obsolete event types
• minor #815 Remove other obsolete type members
• major #817 Remove screenshot consumers functionality
• major #822 Extract Artifacts Root path out of Artifacts path
• major #823 Move TimeZone instance property of AtataContext to AtataContext.GlobalProperties
• minor #824 Move BuildStart and BuildStartUtc static properties of AtataContext to AtataContext.GlobalProperties
• minor #825 Move ModeOfCurrent static property of AtataContext to AtataContext.GlobalProperties
• minor #827 Replace file path configuration of NLogFileConsumer with single WithFileNameTemplate method
• minor #828 Update sanitization approach of TestInfo properties NameSanitized and SuiteNameSanitized
• minor #829 Apply [FindByAlt] attribute to Image<TOwner> control
• minor #833 Use Atata.WebDriverExtras package v3.0.0

Feedback

Feel free to use any contact channel if you have problems with migration.