https://github.com/atata-framework/atata
C#/.NET test automation framework for web
https://github.com/atata-framework/atata
atata automated-testing csharp dotnet framework pageobject selenium selenium-webdriver test-automation test-framework testing webdriver
Last synced: 15 days ago
JSON representation
C#/.NET test automation framework for web
- Host: GitHub
- URL: https://github.com/atata-framework/atata
- Owner: atata-framework
- License: apache-2.0
- Created: 2016-01-13T12:54:04.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T16:44:09.000Z (16 days ago)
- Last Synced: 2025-04-07T17:41:13.778Z (15 days ago)
- Topics: atata, automated-testing, csharp, dotnet, framework, pageobject, selenium, selenium-webdriver, test-automation, test-framework, testing, webdriver
- Language: C#
- Homepage: https://atata.io
- Size: 13.5 MB
- Stars: 498
- Watchers: 26
- Forks: 80
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [Atata](https://atata.io)
[](https://www.nuget.org/packages/Atata/)
[](https://github.com/atata-framework/atata/releases)
[](https://dev.azure.com/atata-framework/atata/_build/latest?definitionId=17&branchName=main)
[](https://marketplace.visualstudio.com/items?itemName=YevgeniyShunevych.AtataTemplates)\
[](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)
[](https://atata.io)
[](https://twitter.com/AtataFramework)
C#/.NET web UI test automation full-featured framework based on Selenium WebDriver.
It uses a fluent page object pattern;
has a built-in logging system;
contains a unique triggers functionality;
has a set of ready-to-use components.
One of the key ideas of the framework is to provide a simple and intuitive syntax for defining and using page objects.
A page object implementation requires as less code as possible.
You can describe a page object class without any methods and only have a set of properties marked with attributes representing page components.
*The package targets .NET Standard 2.0, which supports .NET 5+, .NET Framework 4.6.1+ and .NET Core/Standard 2.0+.*
- **[What's new in v3.4.0](https://atata.io/blog/2025/01/26/atata-3.4.0-released/)**
- **[Migrating to Atata 3](https://atata.io/upgrade/to-atata-3/)**
## Features
- **WebDriver**.
Based on [Selenium WebDriver](https://github.com/SeleniumHQ/selenium) and preserves all its features.
- **Page object model**.
Provides a unique fluent page object pattern, which is easy to implement and maintain.
- **Components**.
Contains a rich set of ready-to-use [components](https://atata.io/components/) for inputs, tables, lists, etc.
- **Integration**.
Works on any .NET test engine (e.g. NUnit, xUnit, SpecFlow) as well as on CI systems like Jenkins, GitHub Actions, or TeamCity.
- **Triggers**.
A bunch of [triggers](https://atata.io/triggers/) to bind with different events to extend component behavior.
- **Verification**.
A set of fluent assertion methods and triggers for a component and data verification.
- **Configurable**.
Defines the default component search strategies as well as additional settings. [Atata.Configuration.Json](https://github.com/atata-framework/atata-configuration-json) provides flexible JSON configurations.
- **Reporting/Logging**.
Built-in customizable logging; screenshots and snapshots capturing functionality.
- **Extensible**.
[Atata.HtmlValidation](https://github.com/atata-framework/atata-htmlvalidation) adds HTML page validation.
[Atata.Bootstrap](https://github.com/atata-framework/atata-bootstrap) and [Atata.KendoUI](https://github.com/atata-framework/atata-kendoui) provide extra components.
## Usage
### Page object
Simple sign-in page object for https://demo.atata.io/signin page:
```C#
using Atata;
namespace SampleApp.UITests
{
using _ = SignInPage;
[Url("signin")] // Relative URL of the page.
[VerifyH1] // Verifies that H1 header text equals "Sign In" upon page object initialization.
public class SignInPage : Page<_>
{
[FindByLabel] // Finds element containing "Email" (Email), then finds text element by "id" that equals label's "for" attribute value.
public TextInput<_> Email { get; private set; }
[FindById("password")] // Finds password element by id that equals "password" ().
public PasswordInput<_> Password { get; private set; }
[FindByValue(TermCase.Title)] // Finds button element by value that equals "Sign In" ().
public Button<_> SignIn { get; private set; }
}
}
```
### Test
Usage in the test method:
```C#
[Test]
public void SignIn()
{
Go.To()
.Email.Set("[email protected]")
.Password.Set("abc123")
.SignIn.Click();
}
```
### Setup
```C#
[SetUp]
public void SetUp()
{
AtataContext.Configure()
.UseChrome()
.UseBaseUrl("https://demo.atata.io/")
.Build();
}
```
*Find out more on [Atata usage](https://atata.io/getting-started/#usage). Check [atata-framework/atata-samples](https://github.com/atata-framework/atata-samples) for different Atata test scenario samples.*
## Demo
Demo [atata-framework/atata-sample-app-tests](https://github.com/atata-framework/atata-sample-app-tests) UI tests application demonstrates different testing approaches and features of Atata Framework. It covers main Atata features: page navigation, data input and verification, interaction with pop-ups and tables, logging, screenshot capture, etc.
Sample test:
```C#
[Test]
public void Create()
{
Login()
.New()
.ModalTitle.Should.Be("New User")
.General.FirstName.SetRandom(out string firstName)
.General.LastName.SetRandom(out string lastName)
.General.Email.SetRandom(out string email)
.General.Office.SetRandom(out Office office)
.General.Gender.SetRandom(out Gender gender)
.Save()
.GetUserRow(email).View()
.AggregateAssert(x => x
.Header.Should.Be($"{firstName} {lastName}")
.Email.Should.Be(email)
.Office.Should.Be(office)
.Gender.Should.Be(gender)
.Birthday.Should.Not.Exist()
.Notes.Should.Not.Exist());
}
```
## Documentation
Find out more on [Atata Docs](https://atata.io) and on [Getting Started](https://atata.io/getting-started/) page in particular.
### Tutorials
You can also check the following tutorials:
* [Atata - C# Web Test Automation Framework](https://www.codeproject.com/Articles/1158365/Atata-New-Test-Automation-Framework) - an introduction to Atata Framework.
* [Verification of Page](https://atata.io/tutorials/verification-of-page/) - how to verify web page data using different approaches of Atata Framework.
* [Verification of Validation Messages](https://atata.io/tutorials/verification-of-validation-messages/) - how to verify validation messages on web pages using Atata Framework.
* [Handle Confirmation Popups](https://atata.io/tutorials/handle-confirmation-popups/) - how to handle different confirmation popups using Atata Framework.
* [Multi-Browser Configuration via .runsettings files](https://atata.io/tutorials/multi-browser-configuration-via-runsettings-files/) - how to configure multi-browser tests application using `.runsettings` files.
* [Reporting to Extent Reports](https://atata.io/tutorials/reporting-to-extentreports/) - how to configure Atata reporting to Extent Reports.
## Community
* Slack: [https://atata-framework.slack.com](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)
* Twitter: https://twitter.com/AtataFramework
* Stack Overflow: https://stackoverflow.com/questions/tagged/atata
## Feedback
Any feedback, issues and feature requests are welcome.
If you faced an issue please report it to [Atata Issues](https://github.com/atata-framework/atata/issues),
[ask a question on Stack Overflow](https://stackoverflow.com/questions/ask?tags=atata+csharp) using [atata](https://stackoverflow.com/questions/tagged/atata) tag
or use another [Atata Contact](https://atata.io/contact/) way.
## Contact author
Contact me if you need a help in test automation using Atata Framework, or if you are looking for a quality test automation implementation for your project.
* LinkedIn: https://www.linkedin.com/in/yevgeniy-shunevych
* Email: [email protected]
## Contributing
Check out [Contributing Guidelines](CONTRIBUTING.md) for details.
## SemVer
Atata Framework tries to follow [Semantic Versioning 2.0](https://semver.org/) when possible.
Sometimes Selenium.WebDriver dependency package can contain breaking changes in minor version releases,
so those changes can break Atata as well.
But Atata manages its sources according to SemVer.
Thus backward compatibility is mostly followed and updates within the same major version
(e.g. from 2.1 to 2.2) should not require code changes.
## License
Atata is an open source software, licensed under the Apache License 2.0.
See [LICENSE](LICENSE) for details.