Ossa.TestFramework.Templates 0.4.0

Ossa.TestFramework.Templates

Overview

The 'Ossa.TestFramework.Templates' Nuget package is a collection of templates designed to speed up the process of creating and deploying Visual studio projects/solutions. It utilises technologies such as .Net, C#, Entity Framework,SQL server, Azure devops, Terraform and testing frameworks such as Nunit, Playwright and Selenium

It benefits the developer by reducing time to wire up and configure every day essentials such as Logging, Dependency Injection, Configuration, Testing and Deployment.

For UI testing, it reduces issues such as updating browser drivers and provides a more stable and reliable testing framework.

It provides an abstraction for the developer to write Web based UI test that can be run with either Selenium or Playwright, without restricting the use of the frameworks native code. Not sure which framework best for you? No problem, you can start coding and switch over when you find and issues or limitations.

It provides a structured template for more complex terraform deployments and Azure Devops pipelines, allowing for a more consistent and reliable deployment process.

It provides an opinionated approach to provide consistency and best practices for the developer, but also allows for customisation and extension.

List of templates

ossa-prereq

Sets up the prerequisites/invoke-build/folder structure/build and setup powershell files for use with the other templates.

ossa-webapp-server

A simple web app template that can run as a windows service or a console app, and insludes logging, configuration, dependency injection.

ossa-database

A simple database template utilising Entity framework core that can be used to create a database and seed data and implement migrations/updates. It also provides a simple repository pattern for data access.

ossa-test-selenium

A web based UI test project using Selenium and Nunit, with some examples of using Ossa.TestFramework wrapper classes.

ossa-test-playwright

A web based UI test project using Playwright and Nunit, with some examples of using Ossa.TestFramework wrapper classes.

ossa-test-pipelines

A template for setting up a Azure Devops pipeline for a .Net project.

ossa-terraform

A template for setting up a terraform project for deploying infrastructure as code.

ossa-schema-drift

A template for detecting change in terraform state.

Getting started

We recommend initially starting from a blank solution and adding the templates as required, but you can add the templates to existing solutions. To install the Ossa.TestFramework.Templates Nuget package, follow these steps:

Open the NuGet Package Manager in Visual Studio. Search for "Ossa.TestFramework.Templates" in the package search bar. Select the package from the search results. Click on the "Install" button to add the package to your project. or alternatively use 'dotnet new install Ossa.TestFramework.Templates::<version>'

To list available templates, run the following command in a powershell window or package manager:dotnet new --list ossa

To create a new project using the templates, follow these steps:

Open the command prompt or terminal. Run the following command to create a new project using the desired template: dotnet new ossa-webapp-server dotnet new ossa-database dotnet new ossa-test-selenium dotnet new ossa-test-playwright dotnet new ossa-test-pipelines dotnet new ossa-terraform dotnet new ossa-schema-drift

Replace the template name with the desired template name from the list above. Reloading or refreshing the solution should show the new project in the solution explorer.

Prerequisites

Depending on desired template you may require all or some of the following:

• Visual Studio 2022 or later
• .NET 8.0 or later
• Azure Devops account
• Terraform
• SQL Server
• Entity Framework Core
• Powershell 5.1 or later

Usage

The templates are designed to be used as a starting point for your project, and can be customised and extended as needed. Invoke build commands are pre-prepared to do a variety of tasks such as building, testing, deploying and cleaning up. These can be run by the developer or pipelines.

Some Typical commands are :

./build.ps1 generate

./build.ps1 generate-app

./build.ps1 generate-db

./build.ps1 generate-iac

./build.ps1 test-unit

./build.ps1 test-integration

./build.ps1 clean

More information is available in the ossa WIKI on how to use the templates and the Ossa packages.

Additional documentation

The package is based around the following Ossa packages:

• Ossa.TestFramework.Core

• Ossa.TestFramework.Playwright

• Ossa.TestFramework.Selenium

The Ossa Utilities WIKI has more information and tutorials on the Ossa packages and how to use them:

The following resources can help you get started with the technologies used in the Ossa.TestFramework.Templates package:

• Nunit: https://docs.nunit.org/
• Invoke Build: https://github.com/nightroman/Invoke-Build/wiki
• Powershell: https://learn.microsoft.com/en-us/powershell/
• Playwright: https://playwright.dev/dotnet/docs/intro
• Selenium: https://www.selenium.dev/documentation/en/
• Azure Devops: https://docs.microsoft.com/en-us/azure/devops/?view=azure-devops
• Terraform: https://developer.hashicorp.com/terraform/tutorials
• Entity Framework:
• SQL Server: https://docs.microsoft.com/en-us/sql/sql-server/