Add vault_config_ui_custom_message resource #2154

marcboudreau · 2024-02-23T15:53:17Z

Description

This PR introduces a new resource named vault_config_ui_custom_message to the provider to allow managing the newly introduced UI Custom Messages in Vault v.1.16.0.

Checklist

Added CHANGELOG entry (only for user-facing changes)
Acceptance tests where run against all supported Vault Versions

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccConfigUICustomMessage'

==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test -run=TestAccConfigUICustomMessage -timeout 30m ./...
?       github.com/hashicorp/terraform-provider-vault   [no test files]
?       github.com/hashicorp/terraform-provider-vault/cmd/coverage      [no test files]
?       github.com/hashicorp/terraform-provider-vault/cmd/generate      [no test files]
?       github.com/hashicorp/terraform-provider-vault/helper    [no test files]
?       github.com/hashicorp/terraform-provider-vault/internal/consts   [no test files]
ok      github.com/hashicorp/terraform-provider-vault/codegen   0.658s [no tests to run]
?       github.com/hashicorp/terraform-provider-vault/internal/identity/group   [no test files]
?       github.com/hashicorp/terraform-provider-vault/internal/identity/mfa     [no test files]
?       github.com/hashicorp/terraform-provider-vault/internal/pki      [no test files]
?       github.com/hashicorp/terraform-provider-vault/internal/sync     [no test files]
?       github.com/hashicorp/terraform-provider-vault/schema    [no test files]
ok      github.com/hashicorp/terraform-provider-vault/internal/identity/entity  0.859s [no tests to run]
ok      github.com/hashicorp/terraform-provider-vault/internal/provider 2.097s [no tests to run]
ok      github.com/hashicorp/terraform-provider-vault/testutil  1.292s [no tests to run]
ok      github.com/hashicorp/terraform-provider-vault/util      1.446s [no tests to run]
ok      github.com/hashicorp/terraform-provider-vault/vault     3.706s

Community Note

Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
Please do not leave "+1" comments, they generate extra noise for pull request followers and do not help prioritize the request

clean up unnecessary code

marcboudreau · 2024-02-23T20:35:00Z

I've added the do-not-merge label for now, because this change should only be adopted once Vault v.1.16.0 is release.

fairclothjm

Looking great so far! Thanks @marcboudreau ! Just a few adjustments needed from what I can see. Great work! :)

fairclothjm · 2024-02-23T20:37:00Z

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased

+FEATURES:
+* Add new resource `vault_config_ui_custom_message`: ([#2154](https://github.com/hashicorp/terraform-provider-vault/pull/2154)).


Suggested change

* Add new resource `vault_config_ui_custom_message`: ([#2154](https://github.com/hashicorp/terraform-provider-vault/pull/2154)).

* Add new resource `vault_config_ui_custom_message`. Requires Vault 1.16+: ([#2154](https://github.com/hashicorp/terraform-provider-vault/pull/2154)).

Could we move this down to the "FEATURES" block below?

fairclothjm · 2024-02-23T20:39:34Z

vault/resource_config_ui_custom_messages.go

+
+func configUICustomMessageResource() *schema.Resource {
+	return &schema.Resource{
+		CreateContext: configUICustomMessageCreate,


Since this endpoint is only available in Vault 1.16 we can add a minimum version requirement to the entire resource

Suggested change

CreateContext: configUICustomMessageCreate,

CreateContext: provider.MountCreateContextWrapper(configUICustomMessageCreate, provider.VaultVersion116),

If we add this, then we are safe to merge before Vault 1.16 is released. We usually do a TFVP release shortly after the Vault release. So this will allow us to not have to scramble to get things merged and in sync between the two projects. :)

fairclothjm · 2024-02-23T20:47:24Z

vault/resource_config_ui_custom_messages.go

+	}
+
+	if secret == nil || secret.Data == nil {
+		return diag.Errorf("response from Vault server is empty")


I believe this block will tell us that the resource does not exist in Vault. In this case, we will want to unset the ID and return nil to signal to Terraform that this object should be removed from state.

Suggested change

return diag.Errorf("response from Vault server is empty")

log.Printf("[WARN] Custom message not found, removing from state")

d.SetId("")

return nil

fairclothjm · 2024-02-23T20:50:25Z

vault/resource_config_ui_custom_messages_test.go

+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		PreCheck:          func() { testutil.TestAccPreCheck(t) },


Suggested change

PreCheck: func() { testutil.TestAccPreCheck(t) },

PreCheck: func() { testutil.TestAccPreCheck(t) },

SkipIfAPIVersionLT(t, testProvider.Meta(), provider.VaultVersion116)

This will make sure the test doesn't run against Vault versions that don't support this resource.

fairclothjm · 2024-03-11T15:12:46Z

vault/resource_config_ui_custom_message.go

@@ -146,7 +150,9 @@ func configUICustomMessageRead(ctx context.Context, d *schema.ResourceData, meta
 	}

 	if secret == nil || secret.Data == nil {
-		return diag.Errorf("response from Vault server is empty")
+		log.Printf("response from Vault server is empty")


We need to prepend the log with a level. I would recommend either DEBUG or WARN:

Suggested change

log.Printf("response from Vault server is empty")

log.Printf("[DEBUG] response from Vault server is empty for %q, removing from state", id)

fairclothjm · 2024-03-11T15:16:59Z

vault/resource_config_ui_custom_message.go

+
+	log.Printf("[DEBUG] Reading custom message %q", id)
+	secret, e := client.Sys().ReadUICustomMessage(id)
+	if e != nil {


Does this endpoint return a 404 error if the resource isn't found or is the next if block how we know the resource does not exist in Vault? If Vault does return a 404, we should remove it from TF state (d.setId("")) here as well.

Here is an example of doing this check:

terraform-provider-vault/vault/resource_approle_auth_backend_role.go

Lines 299 to 307 in 9f97824

if err != nil {

if util.Is404(err) {

log.Printf("[DEBUG] AppRole auth backend role %q not found, removing from state", path)

d.SetId("")

return nil

} else {

return diag.Errorf("error deleting AppRole auth backend role %q, err=%s", path, err)

}

}

Vault does indeed return an HTTP 404 error if no message with the ID provided to the ReadUICustomMessage function exists.

fairclothjm

Approved as long as we make the request changes. Thanks @marcboudreau !

fairclothjm · 2024-03-13T19:43:51Z

Clearing out the 4.0.0 milestone for now and we will do another release closer to Vault GA.

fix debug log message format

fairclothjm

LGTM! Thanks @marcboudreau !

github-actions bot added the size/XL label Feb 23, 2024

marcboudreau requested a review from fairclothjm February 23, 2024 15:57

Marc Boudreau added 6 commits February 23, 2024 11:30

add custom message resource

038f19b

fix filename

ee56e5f

corrected field type for link

b1de368

adjusted link field value based on ssh_backend_role example

c5fe3d7

fixed error with reading link value from API response

670b52e

add CHANGELOG entry

c9be60e

marcboudreau force-pushed the marcboudreau/VAULT-22504/custom-message-resource branch from 6ba3ca5 to c9be60e Compare February 23, 2024 16:30

fix failing unit test

0972440

clean up unnecessary code

marcboudreau added the do-not-merge label Feb 23, 2024

fairclothjm requested changes Feb 23, 2024

View reviewed changes

fairclothjm added this to the 3.26.0 milestone Feb 23, 2024

fairclothjm removed the do-not-merge label Feb 23, 2024

fairclothjm modified the milestones: 3.26.0, 3.27.0 Feb 28, 2024

fairclothjm modified the milestones: 3.27.0, 4.0.0 Mar 6, 2024

Marc Boudreau added 3 commits March 8, 2024 10:57

rename files to non-plural form

24fae95

improve change description and moved it to existing FEATURES section

6eb6bfe

add documentation for new resource

0129c2d

github-actions bot added the documentation label Mar 8, 2024

marcboudreau requested a review from fairclothjm March 8, 2024 16:03

fairclothjm reviewed Mar 11, 2024

View reviewed changes

fairclothjm approved these changes Mar 11, 2024

View reviewed changes

fairclothjm removed this from the 4.0.0 milestone Mar 13, 2024

remove custom-message resource from state if it doesn't exist in Vault

759323a

fix debug log message format

fairclothjm approved these changes Mar 19, 2024

View reviewed changes

fairclothjm added this to the 4.1.0 milestone Mar 19, 2024

marcboudreau merged commit 7f4b29f into main Mar 19, 2024
12 checks passed

fairclothjm deleted the marcboudreau/VAULT-22504/custom-message-resource branch March 19, 2024 16:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add vault_config_ui_custom_message resource #2154

Add vault_config_ui_custom_message resource #2154

marcboudreau commented Feb 23, 2024 •

edited

Loading

marcboudreau commented Feb 23, 2024

fairclothjm left a comment

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Feb 23, 2024

fairclothjm Mar 11, 2024 •

edited

Loading

fairclothjm Mar 11, 2024

fairclothjm Mar 11, 2024

marcboudreau Mar 19, 2024

fairclothjm left a comment

fairclothjm commented Mar 13, 2024

fairclothjm left a comment

	* Add new resource `vault_config_ui_custom_message`: ([#2154](https://github.com/hashicorp/terraform-provider-vault/pull/2154)).
	* Add new resource `vault_config_ui_custom_message`. Requires Vault 1.16+: ([#2154](https://github.com/hashicorp/terraform-provider-vault/pull/2154)).

	CreateContext: configUICustomMessageCreate,
	CreateContext: provider.MountCreateContextWrapper(configUICustomMessageCreate, provider.VaultVersion116),

-		return diag.Errorf("response from Vault server is empty")
+		log.Printf("[WARN] Custom message not found, removing from state")
+		d.SetId("")
+		return nil

	log.Printf("response from Vault server is empty")
	log.Printf("[DEBUG] response from Vault server is empty for %q, removing from state", id)

	if err != nil {
	if util.Is404(err) {
	log.Printf("[DEBUG] AppRole auth backend role %q not found, removing from state", path)
	d.SetId("")
	return nil
	} else {
	return diag.Errorf("error deleting AppRole auth backend role %q, err=%s", path, err)
	}
	}

Add vault_config_ui_custom_message resource #2154

Add vault_config_ui_custom_message resource #2154

Conversation

marcboudreau commented Feb 23, 2024 • edited Loading

Description

Checklist

Output from acceptance testing:

Community Note

marcboudreau commented Feb 23, 2024

fairclothjm 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fairclothjm Mar 11, 2024 • edited Loading

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

fairclothjm left a comment

Choose a reason for hiding this comment

fairclothjm commented Mar 13, 2024

fairclothjm left a comment

Choose a reason for hiding this comment

marcboudreau commented Feb 23, 2024 •

edited

Loading

fairclothjm Mar 11, 2024 •

edited

Loading