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

Jump to bottom

AJ-1234: Use helmchart name for pact identifiers. #384

Merged
merged 1 commit into from
Oct 30, 2023
Merged

AJ-1234: Use helmchart name for pact identifiers. #384

merged 1 commit into from
Oct 30, 2023

Conversation

jladieu
Copy link
Contributor

@jladieu jladieu commented Oct 25, 2023 •
edited by jira bot
Loading

This is prefactoring work for AJ-1234

This pairs with broadinstitute/sam#1234, where sam also renames its reference from sam-consumer to just sam.

  • See thread discussing the -consumer and -provider suffix anti-pattern.
  • See thread discussing the recommendation to use the helmchart name.

jladieu
jladieu commented Oct 25, 2023
View reviewed changes
.github/workflows/publish-pacts.yml Outdated
@@ -65,12 +65,12 @@ jobs:
- name: Output consumer contract as non-breaking base64 string
id: encode-pact
run: |
NON_BREAKING_B64=$(cat service/build/pacts/wds-consumer-sam-provider.json | base64 -w 0)
NON_BREAKING_B64=$(cat service/build/pacts/terra-workspace-data-service-sam.json | base64 -w 0)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry about the whitespace churn. This is the only significant line change for this file.

jladieu
jladieu commented Oct 25, 2023
View reviewed changes
service/src/test/java/org/databiosphere/workspacedataservice/pact/SamPactTest.java Outdated
@@ -37,7 +37,7 @@ void setUp() {
RequestContextHolder.setRequestAttributes(new ServletRequestAttributes(request));
}

@Pact(consumer = "wds-consumer", provider = "sam-provider")
@Pact(consumer = "terra-workspace-data-service", provider = "sam")
Copy link
Contributor Author

@jladieu jladieu Oct 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The rename of sam-provider -> sam will need to be accompanied by a similar PR in the sam repo.

Advice welcome on who to ping to add as a reviewer to this PR for context.

@jladieu jladieu requested a review from a team October 25, 2023 19:11
@jladieu jladieu mentioned this pull request Oct 25, 2023
Merged
jladieu added a commit to broadinstitute/sam that referenced this pull request Oct 30, 2023
@jladieu
Use helmchart name for pact identifier.
9bc2592 
This pairs with DataBiosphere/terra-workspace-data-service#384, where `wds` also renames its reference from `sam-provider` 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 helm chart name.
* See [thread](https://broadinstitute.slack.com/archives/C043YJ40719/p1698262189799389) discussing doing this for `sam`.
@jladieu jladieu mentioned this pull request Oct 30, 2023
Merged
@jladieu jladieu force-pushed the rename-sam-consumer-provider branch from 7a031e7 to 77c6712 Compare October 30, 2023 15:09
@jladieu jladieu changed the title Use top level directory name for pact identifiers. AJ-1234: Use helmchart name for pact identifiers. Oct 30, 2023
@jladieu
Use helmchart names for pact identifiers.
7393b8d 
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.
@jladieu jladieu force-pushed the rename-sam-consumer-provider branch from 77c6712 to 7393b8d Compare October 30, 2023 15:30
jladieu
jladieu commented Oct 30, 2023
View reviewed changes
.github/workflows/publish-pacts.yml
@@ -65,12 +65,12 @@ jobs:
- name: Output consumer contract as non-breaking base64 string
id: encode-pact
run: |
NON_BREAKING_B64=$(cat service/build/pacts/wds-consumer-sam-provider.json | base64 -w 0)
NON_BREAKING_B64=$(cat service/build/pacts/wds-sam.json | base64 -w 0)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the whitespace churn, this is the only relevant change in this file.

@jladieu
Copy link
Contributor Author

jladieu commented Oct 30, 2023

Re-requested review as I tweaked the WDS pacticipant name, per: https://broadinstitute.slack.com/archives/C043YJ40719/p1698415650981769

@sonarcloud
Copy link

sonarcloud bot commented Oct 30, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jladieu jladieu merged commit 7e6f8c5 into main Oct 30, 2023
12 checks passed
@jladieu jladieu deleted the rename-sam-consumer-provider branch October 30, 2023 19:11
jladieu added a commit to broadinstitute/sam that referenced this pull request Nov 2, 2023
@jladieu
Use helmchart name for pact identifier.
a7c40bc 
This pairs with DataBiosphere/terra-workspace-data-service#384, where `wds` also renames its reference from `sam-provider` 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 helm chart name.
* See [thread](https://broadinstitute.slack.com/archives/C043YJ40719/p1698262189799389) discussing doing this for `sam`.
jladieu added a commit to broadinstitute/sam that referenced this pull request Nov 6, 2023
@jladieu
Use helmchart name for pact identifier. (#1234)
d9a6342 
This pairs with DataBiosphere/terra-workspace-data-service#384, where `wds` also renames its reference from `sam-provider` 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 helm chart name.
* See [thread](https://broadinstitute.slack.com/archives/C043YJ40719/p1698262189799389) discussing doing this for `sam`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@calypsomatic calypsomatic calypsomatic approved these changes

@nawatts nawatts nawatts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jladieu @nawatts @calypsomatic