Add resource gitlab_user_gpgkey

[yan12125]

Description

Somehow terraform plan always reports the field armored_public_key as
changed.

Closes https://github.com/gitlabhq/terraform-provider-gitlab/issues/1166

PR Checklist Acknowledgement

• I acknowledge that all of the following items are true, where applicable:
  • Resource attributes match 1:1 the names and structure of the API resource in the GitLab API documentation.
  • Examples are updated with:
    • A *.tf file for the resource/s with at least one usage example
    • A *.sh file for the resource/s with an import example (if applicable)
  • New resources have at minimum a basic test with three steps:
    • Create the resource
    • Update the attributes
    • Import the resource
  • No new //lintignore comments were copied from existing code. (Linter rules are meant to be enforced on new code.)

[github-actions]

Welcome @yan12125 👋

It looks like this is your first submission to the Terraform GitLab Provider! If you haven’t already done so, please make sure you have checked out our CONTRIBUTING.md guide to make sure your contribution has all the necessary elements in place for a successful approval.

Thanks again, and welcome to the community! 😃

[yan12125]

Somehow terraform plan always reports the field key as changed.

Here are steps to reproduce:

• Create a resource like this:

resource "gitlab_user_gpgkey" "yan12125" {
    key = <<KEY
-----BEGIN PGP PUBLIC KEY BLOCK-----

xxx
-----END PGP PUBLIC KEY BLOCK-----
KEY
}

• Import the existing key with terraform import gitlab_user_gpgkey.yan12125 123, where 123 is the key ID for the current user.
• terraform plan reports changed resource: (personal information removed)

Warning: Provider development overrides are in effect

The following provider development overrides are set in the CLI configuration:
 - gitlabhq/gitlab in /home/yen/Projects/terraform-provider-gitlab

The behavior may therefore not match any released version of the provider and applying changes may cause the state to become incompatible with published releases.
gitlab_user_gpgkey.yan12125: Refreshing state... [id=130860]

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # gitlab_user_gpgkey.yan12125 must be replaced
-/+ resource "gitlab_user_gpgkey" "yan12125" {
      ~ created_at = "2022-07-19T16:45:31Z" -> (known after apply)
      ~ id         = "123" -> (known after apply)
      ~ key        = <<-EOT # forces replacement
            -----BEGIN PGP PUBLIC KEY BLOCK-----
            
            xxx
            -----END PGP PUBLIC KEY BLOCK-----
        EOT
      ~ key_id     = 123 -> (known after apply)
    }

Plan: 1 to add, 0 to change, 1 to destroy.

─────────────────────────────────────────────────────────────────────────────

Note: You didn't use the -out option to save this plan, so Terraform can't
guarantee to take exactly these actions if you run "terraform apply" now.

The key recorded in terraform.tfstate is the same as my actual key, but somehow my code makes terraform treat them as different.

[timofurrer]

@yan12125 The diff is because with your <<KEY .. KEY syntax the key has a trailing newline which is removed by GitLab. It's a similar situation as I've described in https://github.com/gitlabhq/terraform-provider-gitlab/issues/1174#issuecomment-1184056524.

I suggest that you remove leading and trailing whitespaces from the key in the create function.

[yan12125]

Thanks! Now terraform plan no longer reports differences. Next steps include adding tests and docs. I will adding tests first.

[yan12125]

Added docs and tests - now ready for reviews :)

[timofurrer]

It already looks quite good! I've added a few nitpicks and other comments.

Back to you 🏓

[yan12125]

Thanks! I applied some trivial changes. Others need some time :)

[github-actions]

This pull request has merge conflicts. Please rebase your branch onto main.

[github-actions]

Conflicts are resolved. Thank you! 😀

[yan12125]

Rebased on top of master as upgrading go-gitlab conflicts with upgrades of other dependencies (#1184)

[timofurrer]

A few minor things and make sure to run make reviewable before the next push, to re-generate the docs etc.

Back to you 🏓

[timofurrer]

@yan12125 I'm updating go-gitlab via #1195

[yan12125]

Thanks for the reminder about make renewable. I run it locally with Go 1.19, and it reports that io/ioutil is deprecated. I didn't find that error on CI checks, so I keep that as-is.

internal/provider/config.go:7:2: SA1019: "io/ioutil" has been deprecated since Go 1.16: As of Go 1.16, the same functionality is now provided by package io or package os, and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)
        "io/ioutil"
        ^

[timofurrer]

@yan12125 Can you change that code in the config.go file to use os and os.ReadFile instead of ioutils?

[yan12125]

Can you change that code in the config.go file to use os and os.ReadFile instead of ioutils?

I can try it out. Is it better to make changes in this PR or another PR?

[timofurrer]

@yan12125 let's do another PR, since you've asked ;)

[yan12125]

let's do another PR, since you've asked ;)

Here you go~ #1199

---

Regarding this PR, I rebased on top of the latest main branch and drop changes to go.mod/go.sum.

[timofurrer]

@yan12125 I think we are just a rebase away 🎉 (I've merged #1199)

[yan12125]

Great thanks! Rebased and squashed :)

[yan12125]

Test failures seem unrelated. Both 15.1.3-ce.0 and 15.1.3-ee.0 tests fail with:

    resource_gitlab_project_test.go:121: Step 19/19 error: After applying this test step and performing a `terraform refresh`, the plan was not empty.
        stdout
        
        
        Terraform used the selected providers to generate the following execution
        plan. Resource actions are indicated with the following symbols:
          ~ update in-place
        
        Terraform will perform the following actions:
        
          # gitlab_project.foo will be updated in-place
          ~ resource "gitlab_project" "foo" {
                id                                               = "93"
                name                                             = "foo-1604740959322635418"
                tags                                             = [
                    "bar",
                    "foo",
                ]
                # (63 unchanged attributes hidden)
        
              ~ container_expiration_policy {
                  ~ enabled     = false -> true
                    # (4 unchanged attributes hidden)
                }
            }
        
        Plan: 0 to add, 1 to change, 0 to destroy.

Which appears the same issue as https://github.com/gitlabhq/terraform-provider-gitlab/issues/1039.

[timofurrer]

LGTM 🎉

[timofurrer]

@yan12125 I've re-triggered the tests and it's all looking good now. Nice work 🎉 🚢

[yan12125]

Thank you very much for the time!

[github-actions]

This functionality has been released in v3.17.0 of the Terraform GitLab Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue. Thank you!