Skip to content

Commit 2911c7a

Browse files
committed
Add instructions to README for running s3 tests
1 parent 2194aa8 commit 2911c7a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,22 @@ cargo test
8686
```
8787

8888
Some tests require access to the database. To run them, set the
89-
`CRATESFYI_DATABASE_URL` to the url of a PostgreSQL database. If you are using
90-
the `docker-compose` environment to run tests against, see the
91-
[Docker-Compose][docker-compose-section] section for the default PostgreSQL URL.
92-
You don't have to run the migrations on it or ensure it's empty, as all the
93-
tests use temporary tables to prevent conflicts with each other or existing
94-
data. See the [wiki page on developing outside docker-compose][wiki-no-compose]
89+
`CRATESFYI_DATABASE_URL` in `.env` to the url of a PostgreSQL database,
90+
and set the `AWS_ACCESS_KEY_ID`, `S3_ENDPOINT`, and `AWS_SECRET_ACCESS_KEY` variables.
91+
We have some reasonable default parameters in `.env.sample`.
92+
93+
For example, if you are using the `docker-compose` environment to run tests against, you can launch only the database and s3 server like so:
94+
95+
```console
96+
docker-compose up -d db s3
97+
```
98+
99+
If you don't want to use docker-compose, see the
100+
[wiki page on developing outside docker-compose][wiki-no-compose]
95101
for more information on how to setup this environment.
102+
Note that either way, you will need docker installed for sandboxing with Rustwide.
96103

97104
[wiki-no-compose]: https://github.com/rust-lang/docs.rs/wiki/Developing-without-docker-compose
98-
[docker-compose-section]: #Docker-Compose
99105

100106
### Docker-Compose
101107

0 commit comments

Comments
 (0)