VAULT-29412: Preview of new Vault Radar resource. #1092

trentdibacco · 2024-09-16T20:12:17Z

Preview of Manage a Vault Radar source of type GitHub Enterprise via the HCP Terraform Provider.

Important

This is a preview, and my intent is for this resource not to show up in the in the online documentations.
Therefore, I did not set the subcategory in the markup.

New Resource Checklist

Schema

Uses Globally Unique ID: Uses GUID returned by server.
Validates Fields Where Possible: Minimal
Supports Optional Project ID Input:

CRUD Operations

Uses Context-Aware CRUD Functions:
Uses Context For API Calls:
Uses DRY API Calls: added vault_radar under client dir for reusable client ops.
Handles Existing Resource Prior To Create: ? Server side will return an error during creation, no public api yet for checking prior to creating.
Implements Immediate Resource ID Set During Create: ? before other API operations or returning? Its using the GUID returned by the server side.
Refreshes Attributes During Read: most of these attributes are immutable.
Handles Removed Resource During Read:
Handles Failed State During Read:
Handles Nonexistent Resource Prior To Delete:

Documentation

Includes Descriptions For Resource And Fields:
Includes Example:
Includes Generated Docs:

🛠️ Description

Manage a Vault Radar source of type GitHub Enterprise via the HCP Terraform Provider.

🏗️ Acceptance tests

Warning

This AC test is being skipped because of pre-existing conditions that would be require for the test to succeed.

Requires Project already setup with Radar.
Requires a Service Account with an Admin role on the Project.
Requires access to a GitHub Enterprise Server self-managed instance.
Requires the following environment variables to be set:
- HCP_PROJECT_ID
- RADAR_GITHUB_ENTERPRISE_ORGANIZATION
- RADAR_GITHUB_ENTERPRISE_DOMAIN
- RADAR_GITHUB_ENTERPRISE_TOKEN

Note

I've created a ticket to note how we can address this sometime in the future.
https://hashicorp.atlassian.net/browse/VAULT-31051

Have you added an acceptance test for the functionality being added?
Have you run the acceptance tests on this branch?

Output from acceptance testing:

make testacc TESTARGS='-run=TestRadarSourceGitHubEnterprise'
==> Checking that code complies with gofmt requirements...
golangci-lint run --config ./golangci-config.yml 
TF_ACC=1 go test ./internal/... -v -run=TestRadarSourceGitHubEnterprise -timeout 360m -parallel=10
?   	github.com/hashicorp/terraform-provider-hcp/internal/clients/iampolicy	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/clients/packerv2	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/customdiags	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/clients	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/consul	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/hcpvalidator	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/input	(cached) [no tests to run]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/acctest	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/customtypes	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider	(cached) [no tests to run]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/iam/helper	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/modifiers	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/iam	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/logstreaming	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/datasources/artifact	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/datasources/version	(cached) [no tests to run]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/testutils	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/testutils/configbuilder	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/testutils/configbuilder/packerconfig	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/testutils/testcheck	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/testutils/testclient	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/utils	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/utils/base	[no test files]
?   	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/utils/location	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/packer/resources/bucket	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/resourcemanager	(cached) [no tests to run]
=== RUN   TestRadarSourceGitHubEnterprise
--- PASS: TestRadarSourceGitHubEnterprise (17.23s)
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/vaultradar	17.868s
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/vaultsecrets	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/waypoint	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/webhook	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/provider/webhook/validator	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-hcp/internal/providersdkv2	(cached) [no tests to run]

...

Manage a Vault Radar source of type GitHub Enterprise via the HCP Terraform Provider.

hashicorp-cla-app · 2024-09-16T20:12:31Z

All committers have signed the CLA.

hashicorp-cla-app · 2024-09-16T20:12:32Z

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

_{Have you signed the CLA already but the status is still pending? Recheck it.}

trentdibacco · 2024-09-16T20:43:05Z

internal/provider/vaultradar/resource_radar_source_github_enterprise_test.go

+	token := os.Getenv("RADAR_GITHUB_ENTERPRISE_TOKEN")
+
+	if projectID == "" || githubOrganization == "" || domainName == "" || token == "" {
+		t.Skip("HCP_PROJECT_ID, RADAR_GITHUB_ENTERPRISE_ORGANIZATION, RADAR_GITHUB_ENTERPRISE_DOMAIN, and RADAR_GITHUB_ENTERPRISE_TOKEN must be set for acceptance tests")


@jasonpilz Seems the automated testing is on, and this will fail for CI.

Requires Project already setup with Radar.

Requires a Service Account with an Admin role on the Project.

Requires access to a GitHub Enterprise self-managed instance.

This is a best effort test, and works on my local setup with the proper env setup.

I created the following ticket to try an address this in the future.
https://hashicorp.atlassian.net/browse/VAULT-31051

Sounds good, thanks 👍🏻

docs/resources/vault_radar_source_github_enterprise.md

internal/provider/vaultradar/resource_radar_source_github_enterprise.go

kathytong-hashicorp

Can't say I understand much of the TF stuff but the Radar stuff looks good to me!

docs/resources/vault_radar_source_github_enterprise.md

internal/clients/vault_radar.go

internal/provider/vaultradar/resource_radar_source_github_enterprise.go

docs/resources/vault_radar_source_github_enterprise.md

kartheek-hc

Looks good, have few some questions and suggestions

docs/resources/vault_radar_source_github_enterprise.md

internal/clients/vault_radar.go

internal/provider/vaultradar/resource_radar_source_github_enterprise.go

Update resource desc, fix context, better regex for validating domain name.

When the resource has been marked, but not fully deleted we need to handle this case differently for Get and Delete.

jasonpilz

LGTM!

VAULT-29412: Preview of new Vault Radar resource.

98b6aad

Manage a Vault Radar source of type GitHub Enterprise via the HCP Terraform Provider.

trentdibacco requested review from jasonpilz, kathytong-hashicorp and kartheek-hc September 16, 2024 20:12

trentdibacco added 2 commits September 16, 2024 13:25

Add to changelog.

63a9abb

Skip automated acceptance tests.

21ad172

trentdibacco commented Sep 16, 2024

View reviewed changes

docs/resources/vault_radar_source_github_enterprise.md Show resolved Hide resolved

trentdibacco commented Sep 16, 2024

View reviewed changes

docs/resources/vault_radar_source_github_enterprise.md Show resolved Hide resolved

trentdibacco commented Sep 16, 2024

View reviewed changes

internal/provider/vaultradar/resource_radar_source_github_enterprise.go Show resolved Hide resolved

kathytong-hashicorp approved these changes Sep 16, 2024

View reviewed changes

fix spelling error, minor tweak to docs.

55ba938

kartheek-hc reviewed Sep 17, 2024

View reviewed changes

trentdibacco added 2 commits September 17, 2024 10:55

Address some of Kartheek's PR feedback.

927d27e

Update resource desc, fix context, better regex for validating domain name.

Refine handling of Get and Delete of resource.

b633945

When the resource has been marked, but not fully deleted we need to handle this case differently for Get and Delete.

trentdibacco requested a review from kartheek-hc September 17, 2024 19:07

Minor fix to log message.

32fdeff

kartheek-hc approved these changes Sep 17, 2024

View reviewed changes

trentdibacco marked this pull request as ready for review September 17, 2024 21:15

trentdibacco requested review from a team as code owners September 17, 2024 21:15

trentdibacco requested review from blueberry-pi and helenfufu September 17, 2024 21:15

Merge branch 'main' into radar-VAULT-29412

0d13479

jasonpilz approved these changes Sep 23, 2024

View reviewed changes

trentdibacco added 3 commits September 24, 2024 09:36

update code owners.

2dcdc9a

adj code owner.

0560d1b

Merge remote-tracking branch 'origin/main' into radar-VAULT-29412

2acb829

trentdibacco requested a review from a team as a code owner September 24, 2024 18:15

Merge remote-tracking branch 'origin/main' into radar-VAULT-29412

afddb29

trentdibacco merged commit ef18399 into main Sep 24, 2024
6 checks passed

trentdibacco deleted the radar-VAULT-29412 branch September 24, 2024 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VAULT-29412: Preview of new Vault Radar resource. #1092

VAULT-29412: Preview of new Vault Radar resource. #1092

trentdibacco commented Sep 16, 2024 •

edited

Loading

hashicorp-cla-app bot commented Sep 16, 2024 •

edited

Loading

hashicorp-cla-app bot commented Sep 16, 2024

trentdibacco Sep 16, 2024 •

edited

Loading

trentdibacco Sep 17, 2024

jasonpilz Sep 23, 2024

kathytong-hashicorp left a comment

kartheek-hc left a comment

jasonpilz left a comment

VAULT-29412: Preview of new Vault Radar resource. #1092

VAULT-29412: Preview of new Vault Radar resource. #1092

Conversation

trentdibacco commented Sep 16, 2024 • edited Loading

New Resource Checklist

Schema

CRUD Operations

Documentation

🛠️ Description

🏗️ Acceptance tests

hashicorp-cla-app bot commented Sep 16, 2024 • edited Loading

hashicorp-cla-app bot commented Sep 16, 2024

trentdibacco Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

trentdibacco Sep 17, 2024

Choose a reason for hiding this comment

jasonpilz Sep 23, 2024

Choose a reason for hiding this comment

kathytong-hashicorp left a comment

Choose a reason for hiding this comment

kartheek-hc left a comment

Choose a reason for hiding this comment

jasonpilz left a comment

Choose a reason for hiding this comment

trentdibacco commented Sep 16, 2024 •

edited

Loading

hashicorp-cla-app bot commented Sep 16, 2024 •

edited

Loading

trentdibacco Sep 16, 2024 •

edited

Loading