Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salamonrafal/hotdesk-planner
Web API based on CQRS pattern for manage hotdesking in the office
https://github.com/salamonrafal/hotdesk-planner
cqrs-pattern dotnet dotnet-core dotnet5 webapi
Last synced: 25 days ago
JSON representation
Web API based on CQRS pattern for manage hotdesking in the office
- Host: GitHub
- URL: https://github.com/salamonrafal/hotdesk-planner
- Owner: salamonrafal
- Created: 2021-09-10T20:39:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-13T07:23:15.000Z (about 3 years ago)
- Last Synced: 2023-05-02T00:15:06.537Z (over 1 year ago)
- Topics: cqrs-pattern, dotnet, dotnet-core, dotnet5, webapi
- Language: C#
- Homepage:
- Size: 5.41 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hotdesk-planner
[](https://github.com/salamonrafal/hotdesk-planner/actions/workflows/dotnet.yml)  
* [Unit & Integration tests](#Unit--Integration-tests)
* [Integration tests](#Integration-tests)
* [Structure of directories](#Structure-of-directories)
* [Mocking MongoDB](#Mocking-MongoDB)
* [Code Coverage](#Code-Coverage)
* [Unit tests](#Unit-tests)
* [Structure of directories](#Structure-of-directories)
* [Model validation](#Model-validation)
* [Validation Types](#Validation-Types)
* [Docker image](#Docker-image)
* [Manual create docker image](#Manual-create-docker-image)
* [Manual create docker container](#Manual-create-docker-container)
* [Scripts to create docker images & containers](#Scripts-to-create-docker-images--containers)
* [Script build image](#Script-build-image)
* [Script create container](#Script-create-container)
## Unit & Integration tests
I use to test coverage NUnit test framework and FluentAssertion for both type of testing. All type of test placed inside `Tests` directory.
### Integration tests
#### Structure of directories:
```textmate
- Test
- Integration
- AppData
: Directory contains test data for feeding test server MongoDB
- ApplicationFactories
: Directory contains object for create test server application
- Fixtures
: Directory contains test fixtures
- Helpers
: Directory contains tools and objects use in test
- Tests
: Directory contains test cases
```
#### Mocking MongoDB
Integration tests are free of network dependencies.
For example if some reasons can broke connection with MongoDB server or MongoDB server will be unreachable then Integration test will be work.
For those reasons tests use external package [Mongo2Go](https://github.com/Mongo2Go/Mongo2Go)
#### Code Coverage
For calculate code coverage was used [Coverlet](https://github.com/coverlet-coverage/coverlet#coverlet) and for generating report human readable was used [ReportGenerator](https://github.com/danielpalme/ReportGenerator#reportgenerator).
For create coverage report you have to use script:
**For Windows platform**
```cmd
C:repos\hotdesk-planner> .\scripts\win\code-coverage.ps1
```
**Reports**
Script generate two versions of code coverage: HTML and XML. Both versions placed inside `./.coverage/reports/` directory.
### Unit tests
#### Structure of directories:
```textmate
- Test
- Unit
- Api
: Directory contains test cases for project Api
- Core
: Directory contains test cases for project Core
- Infrastructure
: Directory contains test cases for project Infrastructure
- Helpers
: Directory contains tools and objects use in test
- AppData
: Directory contains test data for feeding tests
```
## Model validation
Service use `FluentValidation` for validating data models before run any action with repository.
All Validators you find in `Core.Validators`. Any information about external package for validating use in project you able to read: [https://docs.fluentvalidation.net/en/latest/index.html](https://docs.fluentvalidation.net/en/latest/index.html)
### Validation Types
Service has defined rules of set depends what action you need to execute:
* _Core.Enums.ValidationModelType.GetOne_
* _Core.Enums.ValidationModelType.Insert_
* _Core.Enums.ValidationModelType.Update_
* _Core.Enums.ValidationModelType.Delete_
## Docker image
### Manual create docker image
You able to create manual docker image with service from source. Below you find command with description
```shell
docker build -t helpdesk-service/dev \
--build-arg SERVICE_BUILD_PLAN=Debug \
--build-arg SERVICE_PORT=3002 \
--build-arg SERVICE_ENV=Development \
--build-arg SERVICE_URL=http://+:3002 .
```
__Build arguments__
* SERVICE_BUILD_PLAN _You can choose between ___Debug___ or ___Release____
* SERVICE_PORT _Define for which port service will be available_
* SERVICE_ENV _Define is it ___Production___ or ___Development___ environment_
* SERVICE_URL _Define for which url service should listening_
### Manual create docker container
You able create manual docker container with service. Below you will find command:
```shell
docker run -d -p 3002:3002 --name service-name helpdesk-service/dev
```
### Scripts to create docker images & containers
#### Script build image
**For windows:**
```powershell
./scripts/win/build-image.ps1 [-env [Development|Production]] [-port [0-9+]] [-args [*]]
```
**List of parameters:**
* _-env_ - Define environment. **Default: _Production_**
* _-port_ - Define port for which service should listening. **Default: _3000_**
* _-args_ - Define additional arguments.
**Example:**
```powershell
./scripts/win/build-image.ps1 -env Development -port 3001
```
#### Script create container
**For windows:**
```powershell
./scripts/win/create-image.ps1 -name [*] [[-env [Production|Development]] [-port [0-9+]] [-build-image 0|1]]
```
**List of parameters:**
* _-name_ - Define service name for docker. **Required**
* _-env_ - Define environment. **Default: _Production_**
* _-port_ - Define port for which service should listening. **Default: _3000_**
* _-buildImage_ - If image does not exist then first build the image and next the container.
**Example:**
```powershell
./scripts/win/create-image.ps1 `
-name SomeService `
-env Development `
-port 3001
```