Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(makefile): add targets for generation and testing #88

Merged
merged 5 commits into from
Jul 31, 2024
Merged

chore(makefile): add targets for generation and testing #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7acf82e
chore(makefile): add targets for generation and testing
MR2011 Jul 26, 2024
6ac1030
Merge branch 'main' into makefile
drochow Jul 30, 2024
42e521f
docs(mockery): added mockery section to readme
drochow Jul 30, 2024
3428ed6
Merge remote-tracking branch 'origin/makefile' into makefile
drochow Jul 30, 2024
b94e949
chore(makefile): add fmt
MR2011 Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ VERSION ?= $(shell git log -1 --pretty=format:"%H")
OS := $(shell go env GOOS)
ARCH := $(shell go env GOARCH)

.PHONY: all test doc
.PHONY: all test doc gqlgen test-all test-e2e test-app test-db

# Source the .env file to use the env vars with make
-include .env
Expand Down Expand Up @@ -47,3 +47,24 @@ push:

run:
go run cmd/heureka/main.go

gqlgen:
cd internal/api/graphql && go run github.com/99designs/gqlgen generate

mockery:
mockery

test-all:
ginkgo -r

test-e2e:
ginkgo internal/e2e

test-app:
ginkgo internal/app

test-db:
ginkgo internal/database/mariadb

fmt:
go fmt ./...
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ make start-all-heureka

### Tests

#### Mockery

Heureka uses [Mockery](https://vektra.github.io/mockery/) for building Mocks based on defined interfaces for the purpose of Unit-Testing.

Please [follow the steps to install mockery on your local system](https://vektra.github.io/mockery/latest/installation/) to be able to build mocks.

#### Using Ginkgo

Heureka uses [Ginkgo](https://onsi.github.io/ginkgo/) for behavior-driven development (BDD) style tests. In the current project setup, tests are organized into three different directories, each serving a specific purpose:

- End-to-End Tests: These tests are located in the ./internal/e2e directory. End-to-end tests are designed to test the flow of an application from start to finish and ensure all integrated pieces of an application function as expected together.
Expand Down Expand Up @@ -136,8 +144,6 @@ ginkgo -focus="Getting Services" ./internal/database/mariadb
```
If the test block you're trying to run depends on `BeforeEach`, `JustBeforeEach`, or `Describe` blocks that aren't being run when you use the `-focus` flag, this could cause the test to fail.



## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/<your-project>/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
Expand Down
Loading