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.

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

Add to pact readme. #1233

Merged
merged 3 commits into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,3 +290,6 @@ To view the SQL commands generated by ScalikeJDBC, set `scalikejdbc.global.loggi
## Smoke Tests
Sam includes smoke tests that can be run anywhere and test a running Sam instance on any network accessible host. See
the [Smoke Test README](smoke_test/README.md) for more information.

## Pact Contract Tests
See the [Pact README](pact4s/README.md) for more information.
8 changes: 8 additions & 0 deletions pact4s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The credentials for authenticating with the Pact Broker can be found here:
On the command line, you can try the following:

```shell
source env/local.env
source src/main/resources/rendered/secrets.env
export PACT_BROKER_URL="https://pact-broker.dsp-eng-tools.broadinstitute.org/"
export PACT_BROKER_USERNAME=$(vault read -field=basic_auth_read_only_username secret/dsp/pact-broker/users/read-only)
export PACT_BROKER_PASSWORD=$(vault read -field=basic_auth_read_only_password secret/dsp/pact-broker/users/read-only)
Expand All @@ -21,6 +23,12 @@ In IntelliJ, you can create a Run Configuration for `SamProviderSpec.scala` and
* `PACT_BROKER_USERNAME`
* `PACT_BROKER_USERNAME`

Or you can run the following command from the root of the project:

```shell
sbt "set scalafmtOnCompile := false" "project pact4s" "testOnly *SamProviderSpec"
```

## References
* https://broadworkbench.atlassian.net/wiki/spaces/IRT/pages/2660368406/Getting+Started+with+Pact+Contract+Testing
* https://broadworkbench.atlassian.net/wiki/spaces/IRT/pages/2681143308/Pact+Broker+Infrastructure
Loading