https://github.com/num30/golang-service-test
This is an example of and integration test for Golang Rest API service
https://github.com/num30/golang-service-test
Last synced: about 1 year ago
JSON representation
This is an example of and integration test for Golang Rest API service
- Host: GitHub
- URL: https://github.com/num30/golang-service-test
- Owner: num30
- License: mit
- Created: 2022-09-11T12:35:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T12:01:21.000Z (over 2 years ago)
- Last Synced: 2025-05-09T01:47:44.737Z (about 1 year ago)
- Language: Go
- Size: 40 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Service Test Example
## Objective
Service tests are automated tests executed against an instance of running service, usually after deployment, to ensure that the service works properly with other parts of the system. For example, if a service uses DB then we want to test its interface and ensure that the data from DB is returned.
In [testing pyramid](https://martinfowler.com/articles/practical-test-pyramid.html) they are located between unit-test and end-to-end tests. The main target of those tests is service API so it's fairly easy to write them which makes them a crucial part of software quality assurance
## Scope
This repository demonstrates one of the approaches to write, run and maintain service tests for a Golang service.
## What is in the repository?
In this repo you will find:
- simple [Rest API server](/pkg/router/router.go)
- [service test](/test/stest/rest_service_test.go) for the API
- [Docker file for service test build](Test.Dockerfile)
- Script to build [service test image](/Makefile)
- [Github Action pipeline](/.github/workflows/build.yaml) to build and push service test image
## Let's break it down
We have our basic api service declared in [router.go](/pkg/router/router.go) file with three methods:
- `GET /ping` - returns 200 OK and pong in response
- `GET /boxes/{box_id}` - returns Json with box content by it's ID
- `PUT /boxes/{box_id}` - updates box content by it's ID
We have a [test](/test/stest/rest_service_test.go) that checks that our service works as expected. Test is written as a go tests the only difference is that we don't access any methods directly but use HTTP calls to call our service.
## Building Test Image
Running locally is good for one time verification. In order to run test as part of CI/CD pipeline we need to build and push service test image. To do that we will build a test binary first
```
env CGO_ENABLED=0 go test ./test/stest -tags servicetest -v -c -o bin/service-test
```
then we will build a docker image using [Test.Dockerfile](Test.Dockerfile) created specifically for service tests.
```
docker build -f Test.Dockerfile -t service-test .
```
You probably want to do it in a pipeline so [here is an example of Github Action pipeline](.github/workflows/build.yaml) that does that for you.
We build application image with two tags `[short-commit-sha]` and `[branch-name]-[build-number]` test image is being built with the same tags but with `-test` suffix. That way we use same Docker repository for both application and test images. You may consider having separate repository although I would suggest to stick to some naming conventions. This will make it easier to deal with running the test later.
## Runnig Tests
### Locally
Our service test have a `servicetest` build tag that prevents our test from running with `go test ./...` command.
To run our test locally:
```
go test ./test/stest -tags servicetest -v -count=1
```
### Docker
Test are packaged into a docker image so we can run them in a container. This docker container is easy to run in a K8s as part of helm test, k8s job, or as a step in a CD pipeline.
### Helm Chart
If you use helm charts to deploy you application then you can use [helm test](https://helm.sh/docs/topics/chart_tests/) to run your service tests. Here is an example of [helm test file](/helm/boxes-api/templates/tests/test-service.yaml).
The advantage of this approach is tha you can run test by executing `helm test` command.
Try this example in Kubernetes by running:
```
helm install int-example boxes-api
helm test int-example
kubectl logs int-example-boxes-api-test-service
```
## Results
The test results are reported in a log of a container.
However, if you want to aggregate test results and keep the history of execution then you make consider using [testhub](https://github.com/testhub-io/testhub) for that.