This is a smaple project with the aim of implementing MongoDB and Cassandra as repositories that can be swapped in/out with one another.
All databases use the Repository pattern and implement the IRepository interface.
The types are:
- In-memory: There is an in-memory database, which is used for testing.
- MongoDB: There is a free cloud MongoDB instance hosted via Mongo Atlas in AWS' Sydney datacenter.
- Cassandra: There is a free cloud Cassandra instance hosted via Datastax AstraDB in Azures' Sydney datacenter.
This is a .net5.0 project. It depends on
- CassandraCSharpDriver v3.17.x
- MongoDB.Driver v2.14.x
- NewtonsoftJson v5.0.x
- NSwag v13.14.x
- xUnit v2.4.x
To get started:
- Run the following to download the above dependancies:
> dotnet restore - Get database instances running
- Signup for free cloud instances of MongoDB or Cassandra (via Datastax).
- Or host MongoDB/Cassandra yourself.
- If using Cassandra, create your table (example code within the CassandraRepository.cs)
- Update the database credentials in appsettings.Development.json
To get it up and running via the command line:
> dotnet run --project .\BooksApi\BooksApi.csproj
# Navigate to localhost:5000/swaggerTo run tests via the command line:
> dotnet test -s .\BooksApi.UnitTests\test.runsettings
# Example output
Passed! - Failed: 0, Passed: 6, Skipped: 1, Total: 7, Duration: 25 ms - BooksApi.UnitTests.dll (net5.0)To run the tests and generate code coverage:
# Install the code coverage tool
> dotnet tool install -g dotnet-reportgenerator-globaltool
# Run the script
> cd .\BooksApi.UnitTests\
> .\GenCodeCoverage.ps1
# Example output
Line coverage: 30.9% (115 of 371)
Branch coverage: 27% (20 of 74)
Method coverage: 26.6% (28 of 105)
# Now open .\TestResults\CoverageReport\index.html to view a detailed breakdown of coverage