fix: Update resourceVSphereDatacenterImport to include any datacenter folder(s) in path

[tenthirtyam]

Description

Updates resourceVSphereDatacenterImport to include the datacenter folder(s) in which the datacenter object may exist.

• If found in a datacenter folder, the leading "/" is removed and the inventory path is used for the folder attribute during the import.

• If the datacenter does not reside in a folder, the value is left empty during the import.

Release Note

r/datacenter - Updates resourceVSphereDatacenterImport to include the datacenter folder in which the datacenter object may exist. [GH-XXXX]

References

Closes #1374

---

Test 1 (With Datacenter Folders)

main.tf

provider "vsphere" {
  vsphere_server       = var.vsphere_server
  user                 = var.vsphere_username
  password             = var.vsphere_password
  allow_unverified_ssl = var.vsphere_insecure
}

resource "vsphere_folder" "folder1" {
  path = "hello"
  type = "datacenter"
}

resource "vsphere_folder" "folder2" {
  depends_on = [
    vsphere_folder.folder1,
  ]
  path = "hello/there"
  type = "datacenter"
}

resource "vsphere_datacenter" "datacenter" {
  depends_on = [
    vsphere_folder.folder1,
    vsphere_folder.folder2,
  ]
  name   = "world"
  folder = "hello/there"
}

❯ terraform import vsphere_folder.folder1 /hello
vsphere_folder.folder1: Importing from ID "/hello"...
vsphere_folder.folder1: Import prepared!
  Prepared vsphere_folder for import
vsphere_folder.folder1: Refreshing state... [id=group-d50057]

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 vsphere_folder.folder2 /hello/there
vsphere_folder.folder2: Importing from ID "/hello/there"...
vsphere_folder.folder2: Import prepared!
  Prepared vsphere_folder for import
vsphere_folder.folder2: Refreshing state... [id=group-d50058]

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 vsphere_datacenter.datacenter /hello/world
vsphere_datacenter.datacenter: Importing from ID "/hello/world"...
vsphere_datacenter.datacenter: Import prepared!
  Prepared vsphere_datacenter for import
vsphere_datacenter.datacenter: Refreshing state... [id=world]

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.

  "resources": [
    {
      "mode": "managed",
      "type": "vsphere_datacenter",
      "name": "datacenter",
      "provider": "provider[\"local/hashicorp/vsphere\"]",
      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "custom_attributes": {},
            "folder": "hello/there",
            "id": "world",
            "moid": "datacenter-50073",
            "name": "world",
            "tags": []
          },
          "sensitive_attributes": [],
          "private": "eyJzY2hlbWFfdmVyc2lvbiI6IjAifQ=="
        }
      ]
    },

Test 2 (Without Datacenter Folders)

main.tf

provider "vsphere" {
  vsphere_server       = var.vsphere_server
  user                 = var.vsphere_username
  password             = var.vsphere_password
  allow_unverified_ssl = var.vsphere_insecure
}

resource "vsphere_folder" "folder1" {
  path = "hello"
  type = "datacenter"
}

resource "vsphere_folder" "folder2" {
  depends_on = [
    vsphere_folder.folder1,
  ]
  path = "hello/there"
  type = "datacenter"
}

resource "vsphere_datacenter" "datacenter" {
  depends_on = [
    vsphere_folder.folder1,
    vsphere_folder.folder2,
  ]
  name   = "world"
}

❯ terraform import vsphere_folder.folder1 /hello
vsphere_folder.folder1: Importing from ID "/hello"...
vsphere_folder.folder1: Import prepared!
  Prepared vsphere_folder for import
vsphere_folder.folder1: Refreshing state... [id=group-d50064]

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 vsphere_folder.folder2 /hello/there
vsphere_folder.folder2: Importing from ID "/hello/there"...
vsphere_folder.folder2: Import prepared!
  Prepared vsphere_folder for import
vsphere_folder.folder2: Refreshing state... [id=group-d50065]

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 vsphere_datacenter.datacenter /world
vsphere_datacenter.datacenter: Importing from ID "/world"...
vsphere_datacenter.datacenter: Import prepared!
  Prepared vsphere_datacenter for import
vsphere_datacenter.datacenter: Refreshing state... [id=world]

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 plan
vsphere_folder.folder1: Refreshing state... [id=group-d50078]
vsphere_folder.folder2: Refreshing state... [id=group-d50079]
vsphere_datacenter.datacenter: Refreshing state... [id=world]

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.

  "resources": [
    {
      "mode": "managed",
      "type": "vsphere_datacenter",
      "name": "datacenter",
      "provider": "provider[\"local/hashicorp/vsphere\"]",
      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "custom_attributes": {},
            "folder": "",
            "id": "world",
            "moid": "datacenter-50066",
            "name": "world",
            "tags": []
          },
          "sensitive_attributes": [],
          "private": "eyJzY2hlbWFfdmVyc2lvbiI6IjAifQ=="
        }
      ]
    },

[hashicorp-cla]

All committers have signed the CLA.

[appilon]

I am looking at this now, it is very odd, Import functions are typically a straight passthrough, in that the imported resource should have all the state specified in the config that was prepared for the import. It should not be necessary to perform any of these transformations. I was able to reproduce the issue in an acceptance test so I am going to dive in.

UPDATE: ☝️ No this is not accurate, the import function is expected to correctly set the ID that would be used in the Read function, it is the Read function's responsibility to use the ID to correctly set all fields in state.

It would be most correct to have the Read function take into account sub folders, based on what I have seen from the govmomi API though that may be impractical. If it's not possible then a solution like what this PR proposes is an okay fix.

[appilon]

Given the behavior of ignoring the folder is present between the Read function and StateRefreshFunc used in I guess polling waiting for creation, and the fact that folder is ForceNew: true I think it's easiest to keep this fix in the import function like you have it. I'll push my acceptance tests to this branch and hopefully merge soon.

[appilon]

Import verification added to the tests:

=== RUN   TestAccResourceVSphereDatacenter_createOnRootFolder
--- PASS: TestAccResourceVSphereDatacenter_createOnRootFolder (29.89s)
=== RUN   TestAccResourceVSphereDatacenter_createOnSubfolder
--- PASS: TestAccResourceVSphereDatacenter_createOnSubfolder (36.39s)

[github-actions]

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 issues. 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.