PathPaver Backend

Clean Architecture ASP.NET Core project using .NET 8.0.

Requirements

• .NET 8.0

Technologies Used

• .NET 8
• ASP.NET
• Serilog
• ML.NET
• Artillery
• EntityFramework
• MongoDB
• Coverlet ( Code Coverage )
• NUnit3 ( For Unit Test )
• ReportGenerator ( To generate HTML report for tests )

Setup

Restore Packages

Same level of .sln

docker restore

Add Cluster informations in Users Secrets

You need to go to src/PathPaver.Web/ and run the following commands with the correct values.

cd src/PathPaver.Web

dotnet user-secrets set "MongoCluster:ConnectionURI" "$THE_MONGODB_URI"
dotnet user-secrets set "MongoCluster:DatabaseName" "$THE_DATABASE_NAME"
dotnet user-secrets set "FrontendUrl" "http://localhost:3000"
dotnet user-secrets set "Security:PrivateKey" "$PRIVATE_KEY"
dotnet user-secrets set "ModelPath" "../PathPaver.ML/Model/model.zip"

# Run backend api
dotnet run

To create XML report with Coverlet for all Tests projects in solution

# For Dev tool env
dotnet new tool-manifest

# Install ReportGenerator tool at a global level
dotnet tool install dotnet-reportgenerator-globaltool

# Generate xml coverage files
dotnet test --collect:"XPlat Code Coverage" "PathPaver.sln" --results-directory:"coverage/"

# Generate HTML Report with ReportGenerator
dotnet reportgenerator "-reports:coverage/*/coverage.cobertura.xml" "-targetdir:coverage/report/coveragereport" -reporttypes:Html

Domain Layer

the project that contains the domain layer, including the entities, value objects, and domain services

Application Layer

the project that contains the application layer and implements the application services, DTOs (data transfer objects), and mappers. It should reference the Domain project.

Infrastructure Layer

The project contains the infrastructure layer, including the implementation of data access, logging, email, and other communication mechanisms. It should reference the Application project.

Presentation Layer

The main project contains the presentation layer and implements the ASP.NET Core web API. It should reference the Application and Infrastructure projects.

Postman tests

To run the Postman tests, you'll need to import the collection into your Postman application.

Next, you must click on the 3 dots of collection (or right-click), and click the "Run Collection" button. This will then run each test in the proper order. Make sure a server is running before testing.

You also need to update the variables in the collection. Click on the collection, go in the Variables tab, and update the email, password and url fields to match what you need.

Stress Tests

This project uses a tool called artillery to run stress tests on our website.

Before running this test, you must create a folder called "test-data", then add a json file called "login.json" inside the folder. This will be used by the stress test script to log into the backend and generate a valid token. This file needs to include an email field and a password field. This needs to match with one of the accounts stored in the backend so you can get a token.

Next, you'll need to download a tool called "jq". It allows json parsing through the command terminal. This is required for the run-test-load-script.sh file, to extract the token and store it in a csv file.

Finally, to run the tests, you just need to run the file run-test-load-script.sh in a terminal, which will automatically do everything required for the artillery tests.

Run Stress test script

cd tests/Artillery

touch test-data/login.json # Add email and password in json format

./run-test-load-script.sh