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

Update testing section of README with current info #1850

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update testing section of README with current info #1850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 5 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,6 @@ For development purposes, you can set up `100eyes` using Docker. To perform the
$ docker compose up
```

#### Run the tests

In Github Actions, we run the tests with the local environment because setting up the containers and running them there is more expensive in terms of time. You can run the tests in the containers, if you don't want to get set up locally with:

```bash
$ docker compose exec app bundle exec rspec
```

NOTE: You should expect the `spec/jobs/signal_adapter` to have failures since we recorded [VCR cassettes](https://github.com/vcr/vcr) from a local env not a containerized one.

#### Messengers

To test out webhooks for Postmark, Telegram or Threema you could use [ngrok](https://ngrok.com/) or a similar tool like [localtunnel](https://www.npmjs.com/package/localtunnel). We recommend `localtunnel` as it is free and open-source software.
Expand All @@ -91,11 +81,13 @@ See this [blog post](https://rossta.net/blog/how-to-specify-local-ruby-gems-in-y

### Testing

To run tests in a Docker container, you can run:
We have a dedicated `.env` file for test enviroment, which can be found at `.env.test.local`, which with our `dotenv` gem is loaded
as a first priority in test environment. We mock values only when needed.

In Github Actions, we run the tests with the local environment because setting up the containers and running them there is more expensive in terms of time. You can run the tests in the containers, if you don't want to get set up locally with:

```bash
$ docker compose exec -it app bash
$ RAILS_ENV=test rspec
$ docker compose exec app bundle exec rspec
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have to set the env variable RAILS_ENV to test to make the test run. So I think we should replace this line with:

$ docker compose exec -e RAILS_ENV=test app bundle exec rspec

```

### Production
Expand Down
Loading