Add azuredevops_serviceendpoint_gcp_terraform resource #742

konturn · 2023-03-30T15:18:28Z

All Submissions:

Have you added an explanation of what your changes do and why you'd like us to include them?
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
My code follows the code style of this project.
I ran lint checks locally prior to submission.
Have you checked to ensure there aren't other open PRs for the same update/change?

What about the current behavior has changed?

Issue Number: 675
This PR adds support for creating a GCP Service Endpoint. This resource is analogous to the one that's being provisioned for AWS in the PR here.

Does this introduce a change to `go.mod`, `go.sum` or `vendor/`?

Yes
No

Does this introduce a breaking change?

Yes
No

Any relevant logs, error output, etc?

(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)

Other information

konturn · 2023-03-30T15:19:31Z

@microsoft-github-policy-service agree

@microsoft-github-policy-service agree

konturn · 2023-03-30T15:19:54Z

@microsoft-github-policy-service agree

konturn · 2023-06-02T17:55:38Z

@xuzhang3 is there any other work required on my end before this can be reviewed?

xuzhang3 · 2023-06-07T03:37:29Z

@konturn can you help resolve the conflicts and update to the latest code. We recently upgrade the API from v5/v6 to v7.

xuzhang3

@konturn Thanks for your contribution. A few changes requested.

website/docs/r/serviceendpoint_gcp.html.markdown need to be documented in azuredevops.erb
Please make sure the acc tests passed.

xuzhang3 · 2023-06-08T08:42:11Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp.go

+	r.Schema[saSecretHashKey] = saSecretHashSchema
+	r.Schema["token_uri"] = &schema.Schema{
+		Type:        schema.TypeString,
+		Optional:    false,


if this property is required, use Required: true, and if optional use Optional: true,

xuzhang3 · 2023-06-08T08:42:22Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp.go

+	}
+	r.Schema["gcp_project_id"] = &schema.Schema{
+		Type:        schema.TypeString,
+		Optional:    false,


if this property is required, use Required: true, and if optional use Optional: true,

xuzhang3 · 2023-06-08T08:43:36Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp.go

+		Sensitive:        true,
+		DiffSuppressFunc: tfhelper.DiffFuncSuppressSecretChanged,
+	}
+	saSecretHashKey, saSecretHashSchema := tfhelper.GenerateSecreteMemoSchema("private_key")


Hash function has been deprecated, can removed.

xuzhang3 · 2023-06-08T08:47:05Z

website/docs/r/serviceendpoint_gcp.html.markdown

+
+# azuredevops_serviceendpoint_gcp
+Manages a GCP service endpoint within Azure DevOps.
+


GCP extension is not installed by default. Add note which extension need installed before using this resource.

xuzhang3 · 2023-06-08T08:51:42Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp.go

+	r := genBaseServiceEndpointResource(flattenServiceEndpointGcp, expandServiceEndpointGcp)
+	r.Schema["client_email"] = &schema.Schema{
+		Type:        schema.TypeString,
+		Required:    false,


if this property is required, use Required: true, and if optional use Optional: true,

…ns, documentation, and removal of deprecated features

konturn · 2023-06-08T19:20:06Z

Alrighty @xuzhang3 I've made all the requested changes, and I've also changed the name scheme to make it more clear that this is a GCP Service Endpoint for Terraform (very similar to the PR here).

xuzhang3 · 2023-06-09T06:47:59Z

@konturn you need merge/rebase the latest code from https://github.com/microsoft/terraform-provider-azuredevops. And ensure the AccTests passed.

konturn · 2023-06-09T15:22:25Z

My bad, thought I had updated--@xuzhang3 I've merged main into my PR branch, and the pipeline is green.

xuzhang3 · 2023-06-12T05:25:41Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp_terraform.go

+		DefaultFunc:      schema.EnvDefaultFunc("AZDO_GCP_SERVICE_CONNECTION_PRIVATE_KEY", nil),
+		Description:      "Private Key for connecting to the endpoint.",
+		Sensitive:        true,
+		DiffSuppressFunc: tfhelper.DiffFuncSuppressSecretChanged,


Should be removed, this function is combined with the hash function

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp_terraform.go

azuredevops/internal/acceptancetests/resource_serviceendpoint_gcp_terraform_test.go

xuzhang3 · 2023-06-12T05:33:59Z

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp_terraform.go

+// ResourceServiceEndpointGcp schema and implementation for gcp service endpoint resource
+func ResourceServiceEndpointGcp() *schema.Resource {
+	r := genBaseServiceEndpointResource(flattenServiceEndpointGcp, expandServiceEndpointGcp)
+	r.Schema["client_email"] = &schema.Schema{


can we simplify the name to email?

We could, but I kept it that way since that's what shows up in the ADO GUI and also in the GCP keyfile json.

…ndpoint_gcp_terraform.go Co-authored-by: xuzhang3 <[email protected]>

…gcp_terraform_test.go Co-authored-by: xuzhang3 <[email protected]>

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp_terraform.go

konturn · 2023-06-15T05:32:18Z

Alrighty, I think that's everything--@xuzhang3 any other changes that need made?

xuzhang3 · 2023-06-15T06:40:28Z

=== RUN   TestAccServiceEndpointGcpTerraform_Basic
=== PAUSE TestAccServiceEndpointGcpTerraform_Basic
=== RUN   TestAccServiceEndpointGcpTerraform_Complete
=== PAUSE TestAccServiceEndpointGcpTerraform_Complete
=== RUN   TestAccServiceEndpointGcpTerraform_update
=== PAUSE TestAccServiceEndpointGcpTerraform_update
=== RUN   TestAccServiceEndpointGcpTerraform_requiresImportErrorStep
=== PAUSE TestAccServiceEndpointGcpTerraform_requiresImportErrorStep
=== CONT  TestAccServiceEndpointGcpTerraform_Basic
=== CONT  TestAccServiceEndpointGcpTerraform_update
=== CONT  TestAccServiceEndpointGcpTerraform_requiresImportErrorStep
=== CONT  TestAccServiceEndpointGcpTerraform_Complete
--- PASS: TestAccServiceEndpointGcpTerraform_Complete (75.38s)
--- PASS: TestAccServiceEndpointGcpTerraform_Basic (75.75s)
--- PASS: TestAccServiceEndpointGcpTerraform_requiresImportErrorStep (83.46s)
--- PASS: TestAccServiceEndpointGcpTerraform_update (112.80s)
PASS
ok      github.com/microsoft/terraform-provider-azuredevops/azuredevops/internal/acceptancetests        114.534s

xuzhang3 · 2023-06-15T06:40:40Z

@konturn LGTM

konturn closed this Mar 30, 2023

konturn reopened this Mar 30, 2023

konturn force-pushed the feat/add-gcp-serviceendpoint branch 5 times, most recently from 0791df8 to 0141408 Compare March 31, 2023 01:57

konturn mentioned this pull request Mar 31, 2023

[proposed enhancement] Add Service Endpoints for the Terraform Extension from Microsoft DevLabs #675

Open

xuzhang3 added new-resource new-feature labels Mar 31, 2023

xuzhang3 added the waiting-response label Jun 7, 2023

xuzhang3 requested changes Jun 8, 2023

View reviewed changes

konturn added 4 commits June 8, 2023 14:22

feat: add gcp serviceendpoint resource

01052bb

fix: formatting

79e53cf

fix: typos

3d079a9

add docs

1956ee3

konturn force-pushed the feat/add-gcp-serviceendpoint branch 2 times, most recently from 128b679 to 8cc051d Compare June 8, 2023 18:48

konturn added 2 commits June 8, 2023 14:48

implement requested changes, including optional attribute modificatio…

8cc051d

…ns, documentation, and removal of deprecated features

feat: update GCP terraform connection naming for clarity

f0ace9d

konturn force-pushed the feat/add-gcp-serviceendpoint branch from 8fc8726 to f0ace9d Compare June 8, 2023 19:11

konturn changed the title ~~feat: add gcp serviceendpoint resource~~ Add azuredevops_serviceendpoint_gcp_terraform resource Jun 8, 2023

Merge branch 'microsoft:main' into feat/add-gcp-serviceendpoint

f7e8684

xuzhang3 requested changes Jun 12, 2023

View reviewed changes

konturn and others added 10 commits June 12, 2023 10:49

Update azuredevops/internal/service/serviceendpoint/resource_servicee…

5b903d3

…ndpoint_gcp_terraform.go Co-authored-by: xuzhang3 <[email protected]>

Update azuredevops/internal/acceptancetests/resource_serviceendpoint_…

bb94265

…gcp_terraform_test.go Co-authored-by: xuzhang3 <[email protected]>

Update azuredevops/internal/acceptancetests/resource_serviceendpoint_…

79598bd

…gcp_terraform_test.go Co-authored-by: xuzhang3 <[email protected]>

Update azuredevops/internal/acceptancetests/resource_serviceendpoint_…

a40b699

…gcp_terraform_test.go Co-authored-by: xuzhang3 <[email protected]>

Update azuredevops/internal/acceptancetests/resource_serviceendpoint_…

79c2c92

…gcp_terraform_test.go Co-authored-by: xuzhang3 <[email protected]>

feat: remove deprecated hash function setting

a60d588

fix: formatting

ebb7da9

fix: remove unused import

48963d4

fix: typo

94351eb

fix: issue in roundtrip conversion

1cf48b9

xuzhang3 requested changes Jun 13, 2023

View reviewed changes

azuredevops/internal/service/serviceendpoint/resource_serviceendpoint_gcp_terraform.go Outdated Show resolved Hide resolved

fix: don't return sensitive value

0c27151

konturn force-pushed the feat/add-gcp-serviceendpoint branch from 3f2e129 to 0c27151 Compare June 13, 2023 14:26

xuzhang3 approved these changes Jun 15, 2023

View reviewed changes

xuzhang3 merged commit 2ed1dba into microsoft:main Jun 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add azuredevops_serviceendpoint_gcp_terraform resource #742

Add azuredevops_serviceendpoint_gcp_terraform resource #742

konturn commented Mar 30, 2023 •

edited

Loading

konturn commented Mar 30, 2023

konturn commented Mar 30, 2023

konturn commented Jun 2, 2023

xuzhang3 commented Jun 7, 2023

xuzhang3 left a comment

xuzhang3 Jun 8, 2023

xuzhang3 Jun 8, 2023

xuzhang3 Jun 8, 2023

xuzhang3 Jun 8, 2023

xuzhang3 Jun 8, 2023

konturn commented Jun 8, 2023

xuzhang3 commented Jun 9, 2023 •

edited

Loading

konturn commented Jun 9, 2023

xuzhang3 Jun 12, 2023

xuzhang3 Jun 12, 2023

konturn Jun 12, 2023

konturn commented Jun 15, 2023

xuzhang3 commented Jun 15, 2023

xuzhang3 commented Jun 15, 2023


		# azuredevops_serviceendpoint_gcp
		Manages a GCP service endpoint within Azure DevOps.

Add azuredevops_serviceendpoint_gcp_terraform resource #742

Add azuredevops_serviceendpoint_gcp_terraform resource #742

Conversation

konturn commented Mar 30, 2023 • edited Loading

All Submissions:

What about the current behavior has changed?

Does this introduce a change to go.mod, go.sum or vendor/?

Does this introduce a breaking change?

Any relevant logs, error output, etc?

Other information

konturn commented Mar 30, 2023

konturn commented Mar 30, 2023

konturn commented Jun 2, 2023

xuzhang3 commented Jun 7, 2023

xuzhang3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

konturn commented Jun 8, 2023

xuzhang3 commented Jun 9, 2023 • edited Loading

konturn commented Jun 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

konturn commented Jun 15, 2023

xuzhang3 commented Jun 15, 2023

xuzhang3 commented Jun 15, 2023

konturn commented Mar 30, 2023 •

edited

Loading

Does this introduce a change to `go.mod`, `go.sum` or `vendor/`?

xuzhang3 commented Jun 9, 2023 •

edited

Loading