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

Refactor the TF Provider to use the experimental Go SDK CloudOpsAPIClient Issue #120 #121

Merged
merged 6 commits into from
Sep 24, 2024

Conversation

jlacefie
Copy link
Collaborator

What was changed

This is a significant change that touched most files in the TF Provider.
Most changes occurred in the client.go file.

  • replaced the gprc dial operations with the go CloudOperationsClient operations
  • replaced client passing between client.go, provider.go, and the resource and data source .go modules with a pointer to the CloudOpsClient stored within client.go
  • other minor dependency and import changes were made as well

Why?

To reduce technical debt and improve the speed at which new protos are exposed through the TF provider, we want to use the Go SDK to access all cloud ops apis as opposed to compiling raw protos and including directly into the TF provider.

Checklist

  • Please review code for correctness, style, best-practices, etc
  • Please determine if the hardcoded version field in client.go is still required. I left this var alone during this refactor
  • Please run all tests and verify all resource and data source function
  • Please deploy to TF
  1. Closes [Feature Request] Update the TF Provider to use the embedded protos in the Temporal Go SDK >= 1.26.0 experimental release #120

  2. How was this tested:
    this change was tested in 2 ways:

  • internal tests were executed using go test ./...
    -- note | it didn't appear that the resource tests were executed using go test ./... . Because of this, individual tests were invoked using go test -v -run commands and referencing specific tests
  • manually by running terraform apply for each resource and data source included in the TF provider
    -- manual tests followed the test instructions included in this repo's README
    -- manual test .tf files are available
  1. Any docs updates needed?
    possibly, i added a Go SDK requirement to the Requirements section of README but did not make any other changes

@jlacefie jlacefie requested a review from a team as a code owner September 21, 2024 17:18
Copy link
Collaborator

@swgillespie swgillespie left a comment

Choose a reason for hiding this comment

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

thank you!

@swgillespie swgillespie merged commit cab53e3 into main Sep 24, 2024
5 checks passed
@swgillespie swgillespie deleted the jlacefie/addnewresources branch September 24, 2024 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants