fix import for random_string & random_password resource #256

wakeful · 2022-05-22T13:29:59Z

What's the problem

when I try to use terraform import with random_string or random_password resource terraform is always trying to recreate the object, terraform.tfstate state file contains null elements instead the default ones.

this problem was also reported by other - #106 and #119

How to reproduce?

Create a new .tf file with content

resource "random_string" "test" {
 length = 4
}

resource "random_password" "password" {
  length = 14
}

and run import statement e.q.

$ terraform import random_password.password securepassword
random_password.password: Importing from ID "securepassword"...
random_password.password: Import prepared!
  Prepared random_password for import
random_password.password: Refreshing state... [id=none]

Import successful!

The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.


$ terraform import random_string.test test
random_string.test: Importing from ID "test"...
random_string.test: Import prepared!
  Prepared random_string for import
random_string.test: Refreshing state... [id=test]

Import successful!

The resources that were imported are shown above. These resources are now in
your Terraform state and will henceforth be managed by Terraform.

Result?

running plan is trying to replace the existing objects

$ terraform plan
random_password.password: Refreshing state... [id=none]
random_string.test: Refreshing state... [id=test]

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:

  # random_password.password must be replaced
-/+ resource "random_password" "password" {
      ~ bcrypt_hash = (sensitive value)
      ~ id          = "none" -> (known after apply)
      + length      = 14 # forces replacement
      + lower       = true # forces replacement
      + min_lower   = 0 # forces replacement
      + min_numeric = 0 # forces replacement
      + min_special = 0 # forces replacement
      + min_upper   = 0 # forces replacement
      + number      = true # forces replacement
      ~ result      = (sensitive value)
      + special     = true # forces replacement
      + upper       = true # forces replacement
    }

  # random_string.test must be replaced
-/+ resource "random_string" "test" {
      ~ id          = "test" -> (known after apply)
      + length      = 4 # forces replacement
      + lower       = true # forces replacement
      + min_lower   = 0 # forces replacement
      + min_numeric = 0 # forces replacement
      + min_special = 0 # forces replacement
      + min_upper   = 0 # forces replacement
      + number      = true # forces replacement
      ~ result      = "test" -> (known after apply)
      + special     = true # forces replacement
      + upper       = true # forces replacement
    }

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

Expected result?

$ terraform plan

random_string.test: Refreshing state... [id=test]
random_password.password: Refreshing state... [id=none]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are needed.

`terraform.tfstate` without my change

{
  "version": 4,
  "terraform_version": "1.2.0",
  "serial": 2,
  "lineage": "4adedd74-eb91-8bbc-afdc-91646ac5c129",
  "outputs": {},
  "resources": [
    {
      "mode": "managed",
      "type": "random_password",
      "name": "password",
      "provider": "provider[\"registry.terraform.io/hashicorp/random\"]",
      "instances": [
        {
          "schema_version": 1,
          "attributes": {
            "bcrypt_hash": "$2a$10$gSUJVtd.2eIJ.JETLDjTpuRNRBK3NqpGzoAgM2k3hGd6u4tVOGDvC",
            "id": "none",
            "keepers": null,
            "length": null,
            "lower": null,
            "min_lower": null,
            "min_numeric": null,
            "min_special": null,
            "min_upper": null,
            "number": null,
            "override_special": null,
            "result": "securepassword",
            "special": null,
            "upper": null
          },
          "sensitive_attributes": [],
          "private": "eyJzY2hlbWFfdmVyc2lvbiI6IjEifQ=="
        }
      ]
    },
    {
      "mode": "managed",
      "type": "random_string",
      "name": "test",
      "provider": "provider[\"registry.terraform.io/hashicorp/random\"]",
      "instances": [
        {
          "schema_version": 1,
          "attributes": {
            "id": "test",
            "keepers": null,
            "length": null,
            "lower": null,
            "min_lower": null,
            "min_numeric": null,
            "min_special": null,
            "min_upper": null,
            "number": null,
            "override_special": null,
            "result": "test",
            "special": null,
            "upper": null
          },
          "sensitive_attributes": [],
          "private": "eyJzY2hlbWFfdmVyc2lvbiI6IjEifQ=="
        }
      ]
    }
  ]
}

hashicorp-cla · 2022-05-22T13:30:04Z

All committers have signed the CLA.

bendbennett

Hi @wakeful and thank you for submitting this PR.

Overall the changes look good.
Would you be able to:

Rebase on main
Amend the tests (see below)
Update the CHANGELOG.md
Amend the comments in /examples/resources/random_password/import.sh and /examples/resources/random_string/import.sh to reflect the change in behaviour and regenerate the docs (i.e., make generate)

Tests

TestAccResourcePasswordBasic
Remove all items except bcrypt_hash from ImportStateVerifyIgnore

ImportStateVerifyIgnore: []string{"bcrypt_hash"},

TestAccResourceString
Remove ImportStateVerifyIgnore

wakeful · 2022-06-08T12:12:53Z

hi @bendbennett

as requested:

Rebase on main
Amend the tests
Update the CHANGELOG.md
Amend the comments in ... - this is not required as there is no change in the importing / usage logic

bendbennett · 2022-06-09T07:56:41Z

Hi @wakeful thank you for making those updates.

I think it might be useful to update the comments in /examples/resources/random_password/import.sh and /examples/resources/random_string/import.sh to reflect that the behaviour of import has been altered (i.e., all attributes that have default values will have these defaults assigned during import). These comments will then be visible to practitioners under https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password#import and https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string#import

wakeful · 2022-06-09T08:23:58Z

hey @bendbennett

import doc where updated,

could you help me fix the broken test? TestAccResourceString

bendbennett

Think the changes in importPasswordFunc and importStringFunc should fix the issues with the tests.

Have left a couple of other minor suggestions.

Thanks for your continuing input on this.

internal/provider/resource_password.go

internal/provider/resource_string.go

examples/resources/random_password/import.sh

examples/resources/random_string/import.sh

internal/provider/resource_password.go

internal/provider/resource_string.go

CHANGELOG.md

internal/provider/resource_password.go

internal/provider/resource_string.go

wakeful · 2022-06-09T17:55:50Z

👋 @bendbennett

thanks for your suggestions 👍
everything should now be in place can you take another look?

bendbennett

@wakeful looks good. Thank you for making the changes.

Only comment I have is to alter the CHANGELOG.md to reflect that these changes are not yet released.

CHANGELOG.md

wakeful · 2022-06-10T08:20:00Z

CHANGELOG.md updated,

thanks for you help @bendbennett

bendbennett · 2022-06-10T08:42:25Z

Closes #106
Closes #119

detro

Left a suggestion, but overall I think this is 👍

internal/provider/resource_string.go

docs/resources/password.md

detro

I initially approved, but then thought of a potential issue where a value set manually before import, would end up overridden by .Default.

internal/provider/resource_password.go

bendbennett

@wakeful I've added comments to the import.sh for random_password and random_string to try and document the behaviour during import.

examples/resources/random_password/import.sh

examples/resources/random_string/import.sh

bendbennett

@wakeful I've attached a couple of templates for use in generating docs relating to imports - resources.zip.

If you expand this and drop the resources directory into the /templates dir and run make generate it should update password.md and string.md with markdown that'll be more practitioner-friendly.

examples/resources/random_password/import.sh

examples/resources/random_string/import.sh

bendbennett · 2022-06-22T08:26:30Z

@wakeful are you happy to adopt the last set of suggested changes?

wakeful · 2022-06-23T08:13:25Z

hey @bendbennett

all updated please check again - sorry for the delays, I needed to concentrate on my day to day job.

bendbennett

@wakeful thank you for your continuing efforts on this PR.
I think we're getting close now.

CHANGELOG.md

examples/resources/random_password/import.sh

examples/resources/random_string/import.sh

templates/resources/string.md.tmpl

…ing all defaults into TF state Co-authored-by: Benjamin Bennett <[email protected]>

wakeful · 2022-06-23T12:38:42Z

Hi @bendbennett

I think all is done now :)

bendbennett

@wakeful nice job! Think we're there. Thank you for your work on this.

github-actions · 2024-05-27T09:46:23Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

wakeful requested a review from a team as a code owner May 22, 2022 13:30

github-actions bot added the size/XS label May 22, 2022

bendbennett mentioned this pull request Jun 7, 2022

Only assign value of number to numeric if number is bool #262

Merged

bendbennett reviewed Jun 7, 2022

View reviewed changes

wakeful force-pushed the correct-random-passwd-and-string-import branch from a004688 to 3808cf3 Compare June 8, 2022 12:06

github-actions bot added size/S and removed size/XS labels Jun 8, 2022

wakeful force-pushed the correct-random-passwd-and-string-import branch from 3808cf3 to 327b8da Compare June 9, 2022 08:20

github-actions bot added the documentation label Jun 9, 2022

bendbennett reviewed Jun 9, 2022

View reviewed changes

github-actions bot added size/M and removed size/S labels Jun 9, 2022

wakeful force-pushed the correct-random-passwd-and-string-import branch 2 times, most recently from 241235c to 3e61088 Compare June 9, 2022 17:50

wakeful requested a review from bendbennett June 9, 2022 17:57

bendbennett reviewed Jun 10, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

wakeful requested a review from bendbennett June 10, 2022 08:18

bendbennett added this to the v3.3.2 milestone Jun 10, 2022

detro approved these changes Jun 10, 2022

View reviewed changes

internal/provider/resource_string.go Show resolved Hide resolved

docs/resources/password.md Outdated Show resolved Hide resolved

detro reviewed Jun 10, 2022

View reviewed changes

internal/provider/resource_password.go Show resolved Hide resolved

bendbennett reviewed Jun 16, 2022

View reviewed changes

examples/resources/random_password/import.sh Outdated Show resolved Hide resolved

examples/resources/random_string/import.sh Outdated Show resolved Hide resolved

github-actions bot added size/L and removed size/M labels Jun 16, 2022

wakeful force-pushed the correct-random-passwd-and-string-import branch from 71804a5 to 4997b53 Compare June 16, 2022 12:00

wakeful requested a review from bendbennett June 16, 2022 12:02

bendbennett reviewed Jun 16, 2022

View reviewed changes

examples/resources/random_password/import.sh Outdated Show resolved Hide resolved

examples/resources/random_string/import.sh Outdated Show resolved Hide resolved

wakeful force-pushed the correct-random-passwd-and-string-import branch from 4997b53 to 7e6267e Compare June 23, 2022 08:11

github-actions bot added size/XL and removed size/L labels Jun 23, 2022

wakeful requested a review from bendbennett June 23, 2022 08:13

bendbennett reviewed Jun 23, 2022

View reviewed changes

wakeful force-pushed the correct-random-passwd-and-string-import branch from 822707c to ef0bc4a Compare June 23, 2022 12:35

fix issue where importing random_string & random_password is not writ…

74c568b

…ing all defaults into TF state Co-authored-by: Benjamin Bennett <[email protected]>

wakeful force-pushed the correct-random-passwd-and-string-import branch from b7acc22 to 74c568b Compare June 23, 2022 12:36

wakeful requested a review from bendbennett June 23, 2022 12:37

bendbennett approved these changes Jun 23, 2022

View reviewed changes

bendbennett merged commit 9d1d5dc into hashicorp:main Jun 23, 2022

bendbennett added a commit that referenced this pull request Jun 23, 2022

Updating CHANGELOG.md (#256)

b7c7057

This was referenced Jun 24, 2022

random_string resource is recreated after import #119

Closed

Import string always forces replacement #106

Closed

MarkRKar mentioned this pull request Aug 23, 2022

feat: string and password import with settings #135

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix import for random_string & random_password resource #256

fix import for random_string & random_password resource #256

wakeful commented May 22, 2022

hashicorp-cla commented May 22, 2022 •

edited

Loading

bendbennett left a comment •

edited

Loading

wakeful commented Jun 8, 2022

bendbennett commented Jun 9, 2022

wakeful commented Jun 9, 2022

bendbennett left a comment

wakeful commented Jun 9, 2022

bendbennett left a comment

wakeful commented Jun 10, 2022

bendbennett commented Jun 10, 2022

detro left a comment

detro left a comment

bendbennett left a comment

bendbennett left a comment

bendbennett commented Jun 22, 2022

wakeful commented Jun 23, 2022

bendbennett left a comment

wakeful commented Jun 23, 2022

bendbennett left a comment

github-actions bot commented May 27, 2024

fix import for random_string & random_password resource #256

fix import for random_string & random_password resource #256

Conversation

wakeful commented May 22, 2022

What's the problem

How to reproduce?

Result?

Expected result?

terraform.tfstate without my change

hashicorp-cla commented May 22, 2022 • edited Loading

bendbennett left a comment • edited Loading

Choose a reason for hiding this comment

Tests

wakeful commented Jun 8, 2022

bendbennett commented Jun 9, 2022

wakeful commented Jun 9, 2022

bendbennett left a comment

Choose a reason for hiding this comment

wakeful commented Jun 9, 2022

bendbennett left a comment

Choose a reason for hiding this comment

wakeful commented Jun 10, 2022

bendbennett commented Jun 10, 2022

detro left a comment

Choose a reason for hiding this comment

detro left a comment

Choose a reason for hiding this comment

bendbennett left a comment

Choose a reason for hiding this comment

bendbennett left a comment

Choose a reason for hiding this comment

bendbennett commented Jun 22, 2022

wakeful commented Jun 23, 2022

bendbennett left a comment

Choose a reason for hiding this comment

wakeful commented Jun 23, 2022

bendbennett left a comment

Choose a reason for hiding this comment

github-actions bot commented May 27, 2024

`terraform.tfstate` without my change

hashicorp-cla commented May 22, 2022 •

edited

Loading

bendbennett left a comment •

edited

Loading