Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Commit

Permalink
Merge pull request #60 from golemcloud/contributing_docs
Browse files Browse the repository at this point in the history
integration tests in CONTRIBUTING.md
  • Loading branch information
senia-psm authored Feb 5, 2024
2 parents a7da045 + 1e90651 commit 96cd4d7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Running integration tests

Integration tests are stored in `tests` directory.

You can run all tests with
```shell
./scripts/it.sh
```

To run individual tests you should first build all executables with `./scripts/build-all.sh` and then run tests by name:
```shell
GOLEM_DOCKER_SERVICES=true GOLEM_TEST_TEMPLATES="./test-templates" cargo test worker_new_instance
```

With `QUIET=true` you can hide services output:
```shell
QUIET=true GOLEM_DOCKER_SERVICES=true GOLEM_TEST_TEMPLATES="./test-templates" cargo test
```

This way tests will use configured versions of golem docker images.
To run tests against the latest binaries without docker - see [`golem-services` CONTRIBUTING.md](https://github.com/golemcloud/golem-services/blob/main/CONTRIBUTING.md)
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,7 @@ cargo install golem-cli
```

## More information
Please check the [Golem Cloud developer documentation portal](https://www.golem.cloud/learn) to learn more about how to get started with *Golem Cloud*!
Please check the [Golem Cloud developer documentation portal](https://www.golem.cloud/learn) to learn more about how to get started with *Golem Cloud*!

## Contributing
Find details [here](CONTRIBUTING.md)

0 comments on commit 96cd4d7

Please sign in to comment.