Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
terrywbrady authored Aug 26, 2024
1 parent 459d8cd commit 508fd09
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,38 @@ graph TD

## Setup

- Choose to run the application (1)locally with Ruby or (2)inside docker
These tests can be run in the follow manner
- from AWS Code Build - [Internal Documentation](https://github.com/CDLUC3/mrt-doc-private/blob/main/uc3-mrt-integ-tests.md)
- using docker containers to run Ruby/Capybara and Headless Chrome
- run locally using a desktop installation of Ruby and Chrome

## Local Setup
### Code Build Setup
- This is the recommended approach for the Merritt Team. See the internal documentation link above

### Local Setup

- Install ruby 3.0
- Chrome installation is required
- `bundle install`

### Local Test Execution
#### Local Test Execution

- `rspec spec`

## Docker Setup
#### Running outside of docker
- Comment out `CHROME_URL: http://chrome:4444/wd/hub`
- `bundle install`
- `INTEG_TEST_ENV=... bundle exec rspec`


### Docker Setup

```
docker-compose build
docker-compose up -d chrome
```

### Docker Test Execution
#### Docker Test Execution

| Domain | Scenario | Command |
| ------ | -------- | ------- |
Expand All @@ -68,12 +80,8 @@ docker-compose up -d chrome
| Development | No Ingest | `docker-compose run --rm -e INTEG_TEST_ENV=development -e INGEST_FILES=none mrt-integ-tests`|
| Development | Preview Url | `docker-compose run --rm -e INTEG_TEST_ENV=development -e INGEST_FILES=none -e PREVIEW_URL='https://...' mrt-integ-tests`|

### Cleanup
#### Cleanup
```
docker-compose down
```

## Running outside of docker
- Comment out `CHROME_URL: http://chrome:4444/wd/hub`
- `bundle install`
- `INTEG_TEST_ENV=... bundle exec rspec`

0 comments on commit 508fd09

Please sign in to comment.