https://github.com/aquality-automation/aquality-selenium-dotnet-template

Template project for aquality-selenium-dotnet library.
https://github.com/aquality-automation/aquality-selenium-dotnet-template

aquality-template automated-testing automation selenium test-automation

Last synced: 5 months ago
JSON representation

Template project for aquality-selenium-dotnet library.

• Host: GitHub
• URL: https://github.com/aquality-automation/aquality-selenium-dotnet-template
• Owner: aquality-automation
• License: apache-2.0
• Created: 2020-04-09T16:11:44.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-29T19:36:35.000Z (almost 2 years ago)
• Last Synced: 2025-09-25T21:14:20.981Z (9 months ago)
• Topics: aquality-template, automated-testing, automation, selenium, test-automation
• Language: C#
• Homepage: https://aquality-automation.github.io/aquality-selenium-dotnet-template
• Size: 8.36 MB
• Stars: 11
• Watchers: 7
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
[![Build Status](https://dev.azure.com/aquality-automation/aquality-automation/_apis/build/status/aquality-automation.aquality-selenium-dotnet-template?branchName=master)](https://dev.azure.com/aquality-automation/aquality-automation/_build/latest?definitionId=10&branchName=master)

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=aquality-automation_aquality-selenium-dotnet-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=aquality-automation_aquality-selenium-dotnet-template)

# This template provides an example project for NUnit and Specflow. To use it, you need to delete the unused project.

# The Allure report is also used. If you don't need it, also delete it from the code.

# Aquality Selenium Template Project

Template for [aquality-selenium-dotnet](https://github.com/aquality-automation/aquality-selenium-dotnet) library.

### Project structure

- **Aquality.Selenium.Template** - project related part with PageObjects, models and utilities

  - **Browsers/**: setting up start up

  - **Configuration/**: classes that used to fetch project config from [Resources/Environment](https://github.com/aquality-automation/aquality-selenium-dotnet-template/blob/master/Aquality.Selenium.Template/Aquality.Selenium.Template/Resources/Environment) folder

  - **Constants/**: custom сonstants 

  - **CustomAttributes/**: custom attributes 

  - **Elements/**: page elements

  - **Enums/**: сommon enums for the project

  - **Extensions/**: сommon extensions for the project

  - **Forms/**: Page Objects

  - **Logging/**: setting up logging for Allure

  - **Models/**: classes that represent data models of the application under the test

  - **Resources/**: resource files such as configurations and test data

  - **Utilities/**: util classes

- **Aquality.Selenium.Template.NUnit** - NUnit implementation of the tests

  - **Constants/**: constants for a NUnit project

  - **Extensions/**: extensions for the NUnit project

  - **Resources/**: resource files such as configurations and test data

  - **Steps/**: Nunit steps

  - **Tests/**: Nunit tests  

- **Aquality.Selenium.Template.SpecFlow** - SpecFlow implementation of the tests

  - **Features/**: Gherkin feature files with test scenarios

  - **Hooks/**: SpecFlow [hooks](https://specflow.org/documentation/Hooks/)

  - **StepDefinitions/**: step definition classes

  - **Transformations/**: SpecFlow [data transformations](https://specflow.org/documentation/Step-Argument-Transformations/)

### Configuration

[settings.json](https://github.com/aquality-automation/aquality-selenium-dotnet-template/blob/master/Aquality.Selenium.Template/Aquality.Selenium.Template/Resources/settings.json) file contains settings of Aquality Selenium library. Additional information you can find [here](https://github.com/aquality-automation/aquality-selenium-dotnet/wiki/Overview-(English)).

[allureConfig.json](https://github.com/aquality-automation/aquality-selenium-dotnet-template/blob/master/Aquality.Selenium.Template/Aquality.Selenium.Template.SpecFlow/allureConfig.json) is a part of Allure Report configuration. See details [here](https://github.com/allure-framework/allure-csharp#configuration).

### Tests execution

Scenarios from feature files can be executed with IDE

or with .NET Core CLI [```dotnet test```](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test) where you can specify all necessary arguments.

### Reporting 

Allure Framework is used as a reporting tool. Report data will be placed in ```{Environment.CurrentDirectory}/allure-results/``` folder (you can change it in ```allureConfig.json``` file).

Run [allure CLI](https://docs.qameta.io/allure/#_commandline) command ```allure serve "{path_to_allure_results_directory}"``` to build and open report in web browser. To generate report in CI use corresponding plugin for your system.

### License

Library's source code is made available under the [Apache 2.0 license](https://github.com/aquality-automation/aquality-selenium-dotnet-template/blob/master/LICENSE).