README.md

Todo Web API

Introduction

This is a simple implementation for a Todo API using ASP.Net Core 6.0 and CLEAN architecture.

What's contained in this project

• Source Implementation
  Source Implementation is divided into three Domains based on DDD-oriented Microservice architecture:
  • API
  • Domain
  • Infrastructure
• Test Implementation
  Test Implementation contains two levels of test:
  • Unit Test
  • Acceptance Test

Project Setup

The following is the recommended setup for Development:

• Visual Studio / Visual Studio Code
• dotnet SDK

  > dotnet --version
  6.0.301
  

• dotnet Tools
  • Entity Framework CLI tool

    dotnet tool install --global dotnet-ef
    

  • ReportGenerator tool for Coverage report

    dotnet tool install -g dotnet-reportgenerator-globaltool
    

  • Generator for shareable HTML Gherkin feature execution report

    dotnet tool install -g SpecFlow.Plus.LivingDoc.CLI
    

• Trust the HTTPS development certificate by running the following command:

  dotnet dev-certs https --trust
  

Build the Project

• If using Visual Studio, the project can be built using "Build Solution" option.
• If using Visual Studio Code, the project can be built from terminal using the following command:

  dotnet build
  

Test the Project

• If using Visual Studio, the project can be tested using "Test Explorer" option.
• If using Visual Studio Code, the project can be tested from terminal using the following commands.
  • Static Testing

    dotnet build -warnaserror
    

  • Unit Testing

    dotnet test .\test\TodoService.UnitTest\
    

  • Unit Testing with Coverage

    dotnet test .\test\TodoService.UnitTest\ --collect:"XPlat Code Coverage"
    reportgenerator -reports:<location of coverage.cobertura.xml> -targetdir:"coveragereport" -reporttypes:Html
    

  • Acceptance Testing

    dotnet test .\test\TodoService.Specs\
    

  • Acceptance Testing with LivingDoc output

    dotnet test .\test\TodoService.Specs\
    livingdoc test-assembly <location of test assmebly file> -t <location of TestExecution.json file>
    

Run the Project

• If using Visual Studio, the project can be run using "Ctrl+F5" option (without debugger) or "F5" option (with debugger).
  Visual Studio launches the default browser and navigates to the swagger documentation for the Web API.
• If using Visual Studio Code, the project can be run using the following command:

  dotnet run --project .\src\TodoService.API\TodoService.API.csproj
  

CI/CD

The project currently uses Github actions for automation of build and tests.

• .NET workflow for automation