Skip to content

Commit 8ceea42

Browse files
Update testing instructions
1 parent 168bef6 commit 8ceea42

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,22 @@ All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-java/tr
129129

130130
For the purposes of contributing to this repo, please update the [`SendGridTest.java`](https://github.com/sendgrid/sendgrid-java/tree/master/src/test/java/com/sendgrid/SendGridTest.java) file with unit tests as you modify the code.
131131

132+
1. Download [prism](https://stoplight.io/prism/) for your platform ([Mac OS X](https://github.com/stoplightio/prism/releases/download/v0.1.5/prism_darwin_amd64)) and save the binary to the sendgrid-ruby directory (or any directory you would like. The sendgrid-ruby directory is chosen mostly for convenience.)
133+
134+
1. Add execute permissions
135+
136+
```bash
137+
chmod +x prism
138+
```
139+
140+
1. In a separate terminal, cd into the directory you chose for prism and start the sendgrid local server which the tests will use.
141+
142+
```bash
143+
./prism run --mock --list --spec https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json
144+
```
145+
146+
1. Now you can run the test suite from the root of the project
147+
132148
```bash
133149
./gradlew test -i
134150
```

0 commit comments

Comments
 (0)