[SKIP CI] Add testing instructions to README #44
15
README.md
15
README.md
|
@ -12,6 +12,21 @@ git submodule update --init --recursive
|
|||
docker-compose up --build
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
Each microservice should have it's own integration and unit tests. Running integration tests should involve the following steps:
|
||||
|
||||
```
|
||||
docker-compose -f docker-compose.integration.yml up
|
||||
go test -tags=integration
|
||||
```
|
||||
|
||||
Unit tests are easier:
|
||||
|
||||
```
|
||||
go test -tags=unit
|
||||
```
|
||||
|
||||
## Background services
|
||||
|
||||
The microservices of Beep rely on a few background services, listed below. All of them are covered by the docker-compose file, but in case one wishes to run a service separately, they need to be provided. What a service needs is mentioned in its description.
|
||||
|
|
|
@ -42,5 +42,7 @@ url=$(http --check-status -b POST \
|
|||
base=master head="$branch" \
|
||||
title="$branch" | jq .html_url -r)
|
||||
|
||||
echo "Merge the pull request for '$repo':"
|
||||
echo
|
||||
echo "Created a new pull request for '$repo':"
|
||||
echo " $url"
|
||||
echo
|
||||
|
|
Loading…
Reference in New Issue