fix: missing vds info with r/cluster import

[burnsjared0415]

In order to have a good experience with our community, we recommend that you read the contributing guidelines for making a pull request.

Summary of Pull Request

Updating Cluster import to solve issues where vds is blank on data source.

Type of Pull Request

• This is a bug fix.
• This is an enhancement or feature.
• This is a code style/formatting update.
• This is a documentation update.
• This is a refactoring update.
• This is a chore update
• This is something else.
  Please describe:

Related to Existing Issues

Closes #210

Test and Documentation Coverage

For bug fixes or features:

• Tests have been completed.
• Documentation has been added/updated.

Breaking Changes?

• Yes, there are breaking changes.
• No, there are no breaking changes.

[tenthirtyam]

The CI caught that the err is assigned but not used.

getFlattenedVdsSpecsForRefs returns both a slice of maps and an error. So the err is necessary to handle potential errors from the apiClient.Clusters.GetVdses.

[burnsjared0415]

here is what the results are now:

 "is_used_by_nsx": true,
                "name": "xxx-vds01",
                "nioc_bandwidth_allocations": [
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 100,
                    "shares_level": "high",
                    "type": "vsan"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "vmotion"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "vdp"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "nfs"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "hbr"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "iSCSI"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 100,
                    "shares_level": "high",
                    "type": "virtualMachine"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 50,
                    "shares_level": "normal",
                    "type": "management"
                  },
                  {
                    "limit": 0,
                    "reservation": 0,
                    "shares": 25,
                    "shares_level": "low",
                    "type": "faultTolerance"
                  }
                ],
                "portgroup": [
                  {
                    "active_uplinks": [
                      "uplink1",
                      "uplink2"
                    ],
                    "name": "xxx-pg-mgmt",
                    "transport_type": "MANAGEMENT"
                  },
                  {
                    "active_uplinks": [
                      "uplink1",
                      "uplink2"
                    ],
                    "name": "xxxx-pg-vmotion",
                    "transport_type": "VMOTION"
                  }
                ]
              }
            ]
          },
          "sensitive_attributes": []
        }
      ]
    }
  ],
  "check_results": null
}

[tenthirtyam]

@burnsjared0415 could you address the following issues failing during the linkting?

  Error: internal/cluster/cluster_operations.go:376:21: ineffectual assignment to err (ineffassign)
  	flattenedVdsSpecs, err := getFlattenedVdsSpecsForRefs(ctx, clusterObj.ID, apiClient)
  	                   ^
  Error: internal/cluster/cluster_operations.go:406:21: ineffectual assignment to err (ineffassign)
  	flattenedVdsSpecs, err := getFlattenedVdsSpecsForRefs(ctx, clusterId, apiClient)

[tenthirtyam]

Rebased based on the changes to main recently. Will need updates given the SDK changes.

[tenthirtyam]

@spacegospod - I recall we made some changes to avoid using JSON200 when we bumped to v0.4.1 of the SDK. Can you suggest an update for this section?

[spacegospod]

Sure thing, what you need is GetResponseAs[YourType](RawResponse)

For reference https://github.com/vmware/terraform-provider-vcf/blob/main/internal/api_client/sddc_manager_client.go#L137

Suggested change

	if vdsResponse.JSON200 == nil {
	return nil, fmt.Errorf("vdsResponse.JSON200 is nil")
	}
	flattenedVdsSpecs := make([]map[string]interface{}, len(*vdsResponse.JSON200))
	for i, vds := range *vdsResponse.JSON200 {
	portGroups := vds.PortGroups
	portGroupSpecs := make([]vcf.PortgroupSpec, len(*portGroups))
	for j, pg := range *portGroups {
	portGroupSpecs[j] = vcf.PortgroupSpec{
	Name: pg.Name,
	TransportType: pg.TransportType,
	ActiveUplinks: pg.ActiveUplinks,
	}
	}
	switches, vcfErr := api_client.GetResponseAs[whatever type vdsResponse.JSON200 is](vdsResponse)
	if vcfErr != nil {
	api_client.LogError(vcfErr)
	return errors.New(*vcfErr.Message)
	}
	...
	// continue processing `switches`
	...

What GetResponseAs does is it checks the response code and parses the raw response body (a byte array) into whatever generic type you provide (if the request is successful) or into vcf.Error (if the request has failed)

[tenthirtyam]

@burnsjared0415 - the following should work:

func getFlattenedVdsSpecsForRefs(ctx context.Context, clusterId string, apiClient *vcf.ClientWithResponses) ([]map[string]interface{}, error) {
	res, err := apiClient.GetVdsesWithResponse(ctx, clusterId)
	if err != nil {
		return nil, err
	}

	switcheObj, vcfErr := api_client.GetResponseAs[[]vcf.Vds](res)
	if vcfErr != nil {
		api_client.LogError(vcfErr)
		return nil, errors.New(*vcfErr.Message)
	}

	flattenedVdsSpecs := make([]map[string]interface{}, len(*switcheObj))
	for i, vds := range *switcheObj {
		portGroups := vds.PortGroups
		portGroupSpecs := make([]vcf.PortgroupSpec, len(*portGroups))
		for j, pg := range *portGroups {
			portGroupSpecs[j] = vcf.PortgroupSpec{
				Name:          pg.Name,
				TransportType: pg.TransportType,
				ActiveUplinks: pg.ActiveUplinks,
			}
		}

		niocBandwidthAllocations := vds.NiocBandwidthAllocations
		niocSpecs := make([]vcf.NiocBandwidthAllocationSpec, len(*niocBandwidthAllocations))
		for k, nioc := range *niocBandwidthAllocations {
			niocType := ""
			if nioc.Type != nil {
				niocType = *nioc.Type
			}

			niocSpecs[k] = vcf.NiocBandwidthAllocationSpec{
				Type: niocType,
				NiocTrafficResourceAllocation: vcf.NiocTrafficResourceAllocation{
					SharesInfo: &vcf.SharesInfo{
						Shares: nioc.NiocTrafficResourceAllocation.SharesInfo.Shares,
						Level:  nioc.NiocTrafficResourceAllocation.SharesInfo.Level,
					},
				},
			}
		}

		vdsSpec := vcf.VdsSpec{
			Name:                         vds.Name,
			IsUsedByNsxt:                 vds.IsUsedByNsxt,
			PortGroupSpecs:               &portGroupSpecs,
			NiocBandwidthAllocationSpecs: &niocSpecs,
		}

		flattenedVdsSpecs[i] = network.FlattenVdsSpec(&vdsSpec)
	}

	return flattenedVdsSpecs, nil
}