Skip to content

Commit 7393b8d

Browse files
committed
Use helmchart names for pact identifiers.
This pairs with broadinstitute/sam#1234, where `sam` also renames its reference from `sam-consumer` to just `sam`. * See [thread](https://broadinstitute.slack.com/archives/C043YJ40719/p1698068076950019) discussing the `-consumer` and `-provider` suffix anti-pattern. * See [thread](https://broadinstitute.slack.com/archives/C043YJ40719/p1698241095600099) discussing the recommendation to use the helmchart name.
1 parent 89ab9ba commit 7393b8d

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

.github/workflows/publish-pacts.yml

+13-13
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ on:
1111

1212
jobs:
1313
init-github-context:
14-
runs-on: ubuntu-latest
15-
outputs:
16-
sha-short: ${{ steps.extract-branch.outputs.sha-short }}
17-
repo-branch: ${{ steps.extract-branch.outputs.repo-branch }}
18-
repo-version: ${{ steps.extract-branch.outputs.repo-version }}
19-
20-
steps:
14+
runs-on: ubuntu-latest
15+
outputs:
16+
sha-short: ${{ steps.extract-branch.outputs.sha-short }}
17+
repo-branch: ${{ steps.extract-branch.outputs.repo-branch }}
18+
repo-version: ${{ steps.extract-branch.outputs.repo-version }}
19+
20+
steps:
2121
- uses: actions/checkout@v3
22-
22+
2323
- name: Extract branch
2424
id: extract-branch
2525
run: |
@@ -44,17 +44,17 @@ jobs:
4444
echo "repo-name=${{ github.event.repository.name }}"
4545
echo "repo-branch=${{ steps.extract-branch.outputs.repo-branch }}"
4646
echo "repo-version=${{ steps.extract-branch.outputs.repo-version }}"
47-
47+
4848
run-consumer-contract-tests:
4949
runs-on: ubuntu-latest
50-
needs: [init-github-context]
50+
needs: [ init-github-context ]
5151
outputs:
5252
pact-b64: ${{ steps.encode-pact.outputs.pact-b64 }}
5353

5454
steps:
5555
- name: Checkout current code
5656
uses: actions/checkout@v3
57-
57+
5858
- name: Set up JDK
5959
uses: actions/setup-java@v2
6060
with:
@@ -65,12 +65,12 @@ jobs:
6565
- name: Output consumer contract as non-breaking base64 string
6666
id: encode-pact
6767
run: |
68-
NON_BREAKING_B64=$(cat service/build/pacts/wds-consumer-sam-provider.json | base64 -w 0)
68+
NON_BREAKING_B64=$(cat service/build/pacts/wds-sam.json | base64 -w 0)
6969
echo "pact-b64=${NON_BREAKING_B64}" >> $GITHUB_OUTPUT
7070
7171
publish-pact-job:
7272
runs-on: ubuntu-latest
73-
needs: [init-github-context, run-consumer-contract-tests]
73+
needs: [ init-github-context, run-consumer-contract-tests ]
7474
permissions:
7575
contents: 'read'
7676
id-token: 'write'

service/src/test/java/org/databiosphere/workspacedataservice/pact/SamPactTest.java

+9-9
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ void setUp() {
3737
RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request));
3838
}
3939

40-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
40+
@Pact(consumer = "wds", provider = "sam")
4141
public RequestResponsePact statusApiPact(PactDslWithProvider builder) {
4242
return builder
4343
.given("Sam is ok")
@@ -50,7 +50,7 @@ public RequestResponsePact statusApiPact(PactDslWithProvider builder) {
5050
.toPact();
5151
}
5252

53-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
53+
@Pact(consumer = "wds", provider = "sam")
5454
public RequestResponsePact downStatusApiPact(PactDslWithProvider builder) {
5555
return builder
5656
.given("Sam is not ok")
@@ -63,7 +63,7 @@ public RequestResponsePact downStatusApiPact(PactDslWithProvider builder) {
6363
.toPact();
6464
}
6565

66-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
66+
@Pact(consumer = "wds", provider = "sam")
6767
public RequestResponsePact writeNoPermissionPact(PactDslWithProvider builder) {
6868
return builder
6969
.given("user does not have write permission", Map.of("dummyResourceId", dummyResourceId))
@@ -78,7 +78,7 @@ public RequestResponsePact writeNoPermissionPact(PactDslWithProvider builder) {
7878
.toPact();
7979
}
8080

81-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
81+
@Pact(consumer = "wds", provider = "sam")
8282
public RequestResponsePact writePermissionPact(PactDslWithProvider builder) {
8383
return builder
8484
.given("user has write permission", Map.of("dummyResourceId", dummyResourceId))
@@ -93,7 +93,7 @@ public RequestResponsePact writePermissionPact(PactDslWithProvider builder) {
9393
.toPact();
9494
}
9595

96-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
96+
@Pact(consumer = "wds", provider = "sam")
9797
public RequestResponsePact deletePermissionPact(PactDslWithProvider builder) {
9898
return builder
9999
.given("user has delete permission", Map.of("dummyResourceId", dummyResourceId))
@@ -108,7 +108,7 @@ public RequestResponsePact deletePermissionPact(PactDslWithProvider builder) {
108108
.toPact();
109109
}
110110

111-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
111+
@Pact(consumer = "wds", provider = "sam")
112112
public RequestResponsePact deleteNoPermissionPact(PactDslWithProvider builder) {
113113
return builder
114114
.given("user does not have delete permission", Map.of("dummyResourceId", dummyResourceId))
@@ -123,7 +123,7 @@ public RequestResponsePact deleteNoPermissionPact(PactDslWithProvider builder) {
123123
.toPact();
124124
}
125125

126-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
126+
@Pact(consumer = "wds", provider = "sam")
127127
public RequestResponsePact userStatusPact(PactDslWithProvider builder) {
128128
var userResponseShape =
129129
new PactDslJsonBody()
@@ -142,7 +142,7 @@ public RequestResponsePact userStatusPact(PactDslWithProvider builder) {
142142
.toPact();
143143
}
144144

145-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
145+
@Pact(consumer = "wds", provider = "sam")
146146
public RequestResponsePact noUserStatusPact(PactDslWithProvider builder) {
147147
return builder
148148
.given("user status info request without access token")
@@ -154,7 +154,7 @@ public RequestResponsePact noUserStatusPact(PactDslWithProvider builder) {
154154
.toPact();
155155
}
156156

157-
@Pact(consumer = "wds-consumer", provider = "sam-provider")
157+
@Pact(consumer = "wds", provider = "sam")
158158
public RequestResponsePact petTokenPact(PactDslWithProvider builder) {
159159
PactDslJsonRootValue responseBody = PactDslJsonRootValue.stringType("aToken");
160160

0 commit comments

Comments
 (0)