Data Source: `azurerm_system_center_virtual_machine_manager_inventory_items` - normalize the resource ID #25955

neil-yechenwei · 2024-05-14T00:47:37Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Swagger indicates that the static segment inventoryItems in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785. But the static segment InventoryItems in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID.

--- PASS: TestAccDataSourceSystemCenterVirtualMachineManagerInventoryItems_basic (314.73s)

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_system_center_virtual_machine_manager_inventory_items - normalize the resource ID for this data source

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

…items - normalize the resource id

tombuildsstuff · 2024-05-14T07:29:31Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

@@ -121,39 +124,67 @@ func (l SystemCenterVirtualMachineManagerInventoryItemsDataSource) Read() sdk.Re
 }
 }

-func flattenInventoryItems(input *[]inventoryitems.InventoryItem, inventoryType string) []InventoryItem {
+func flattenInventoryItems(input *[]inventoryitems.InventoryItem, inventoryType string) ([]InventoryItem, error) {


We intentionally return a pointer and an error, to ensure that we return nil when an error occurs (so that we have to handle the error) - can we update this to match everywhere else in the codebase:

Suggested change

func flattenInventoryItems(input *[]inventoryitems.InventoryItem, inventoryType string) ([]InventoryItem, error) {

func flattenInventoryItems(input *[]inventoryitems.InventoryItem, inventoryType string) (*[]InventoryItem, error) {

neil-yechenwei · 2024-05-14T11:26:35Z

@tombuildsstuff , thanks for the comment. I updated PR. Please take another look. Below is the latest test result I just now re-triggered.

--- PASS: TestAccDataSourceSystemCenterVirtualMachineManagerInventoryItems_basic (332.21s)

stephybun

@neil-yechenwei would you mind resolving the minor comments left on the PR. Once that's done this should be good to go!

stephybun · 2024-05-27T12:17:42Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

 results := make([]InventoryItem, 0)
 if input == nil {
- return results
+ return pointer.To(results), nil


Suggested change

return pointer.To(results), nil

return &results, nil

stephybun · 2024-05-27T12:19:46Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

 }

 for _, item := range *input {
 if props := item.Properties; props != nil {
 inventoryItem := InventoryItem{}

 if v, ok := props.(inventoryitems.CloudInventoryItem); ok && inventoryType == string(inventoryitems.InventoryTypeCloud) {
- inventoryItem.id = pointer.From(item.Id)
+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Can we update this description to explain that all instances of this will use the case insensitive parser, then we don't need to repeat this comment multiple times

Suggested change

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-27T12:19:55Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-27T12:20:04Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-27T12:20:14Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-27T12:20:28Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

 inventoryItem.name = pointer.From(v.InventoryItemName)
 inventoryItem.Uuid = pointer.From(v.Uuid)
 results = append(results, inventoryItem)
 }
 }
 }

- return results
+ return pointer.To(results), nil


Suggested change

return pointer.To(results), nil

return &results, nil

neil-yechenwei · 2024-05-28T01:35:42Z

@stephybun , thanks for the comments. I updated PR. Please take another look. Below is the latest test result that I just now triggered.

--- PASS: TestAccDataSourceSystemCenterVirtualMachineManagerInventoryItems_basic (337.37s)

stephybun

@neil-yechenwei I think my suggestion was misunderstood, there are still duplicate copies of the comment in the function. We only need the comment once, please remove the other instances of it.

stephybun · 2024-05-28T05:07:08Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


The idea of updating the phrasing of the comment above is so that we don't need to duplicate this multiple times in this function. Please remove these.

Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-28T05:07:17Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

stephybun · 2024-05-28T05:07:27Z

...ervirtualmachinemanager/system_center_virtual_machine_manager_inventory_items_data_source.go

+ // Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
+ // But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID


Suggested change

// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785

// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

neil-yechenwei · 2024-05-28T08:45:09Z

@stephybun , thanks for the comments. I updated PR. Please take another look.

stephybun

Thanks @neil-yechenwei LGTM 👍

Data Source: azurerm_system_center_virtual_machine_manager_inventory_…

8b3d6b9

…items - normalize the resource id

github-actions bot added service/systemcentervirtualmachinemanager size/S labels May 14, 2024

tombuildsstuff reviewed May 14, 2024

View reviewed changes

github-actions bot added waiting-response and removed waiting-response labels May 14, 2024

use pointer and error

d159ee5

neil-yechenwei requested a review from tombuildsstuff May 14, 2024 11:26

stephybun requested changes May 27, 2024

View reviewed changes

stephybun added the bug label May 27, 2024

github-actions bot added the waiting-response label May 27, 2024

update description

48d6170

github-actions bot removed the waiting-response label May 28, 2024

neil-yechenwei requested a review from stephybun May 28, 2024 01:35

stephybun requested changes May 28, 2024

View reviewed changes

github-actions bot added the waiting-response label May 28, 2024

remove duplicate message

c74ed75

github-actions bot removed the waiting-response label May 28, 2024

neil-yechenwei requested a review from stephybun May 28, 2024 08:45

stephybun approved these changes May 28, 2024

View reviewed changes

stephybun merged commit c18bce7 into hashicorp:main May 28, 2024
33 checks passed

github-actions bot added this to the v3.106.0 milestone May 28, 2024

stephybun added a commit that referenced this pull request May 29, 2024

Update for #25660 #25993 #26115 #25979 #25955

7cae791

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Data Source: `azurerm_system_center_virtual_machine_manager_inventory_items` - normalize the resource ID #25955

Data Source: `azurerm_system_center_virtual_machine_manager_inventory_items` - normalize the resource ID #25955

neil-yechenwei commented May 14, 2024 •

edited

tombuildsstuff May 14, 2024

neil-yechenwei May 14, 2024

neil-yechenwei commented May 14, 2024

stephybun left a comment

stephybun May 27, 2024

neil-yechenwei May 28, 2024

stephybun May 27, 2024

neil-yechenwei May 28, 2024

stephybun May 27, 2024

neil-yechenwei May 28, 2024

stephybun May 27, 2024

neil-yechenwei May 28, 2024

stephybun May 27, 2024

neil-yechenwei May 28, 2024

stephybun May 27, 2024

neil-yechenwei May 28, 2024

neil-yechenwei commented May 28, 2024

stephybun left a comment

stephybun May 28, 2024

neil-yechenwei May 28, 2024

stephybun May 28, 2024

neil-yechenwei May 28, 2024

stephybun May 28, 2024

neil-yechenwei May 28, 2024

neil-yechenwei commented May 28, 2024

stephybun left a comment

	func flattenInventoryItems(input *[]inventoryitems.InventoryItem, inventoryType string) ([]InventoryItem, error) {
	func flattenInventoryItems(input []inventoryitems.InventoryItem, inventoryType string) ([]InventoryItem, error) {

	// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID
	// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by the API starts with uppercase. So all instances of setting the inventory item ID must use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

		// Service API indicates that the static segment `inventoryItems` in the resource ID of the Inventory Item should start with lowercase. See more details from https://github.com/Azure/azure-rest-api-specs/blob/92c409d93f895a30d51603b2fda78a49b3a2cd60/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json#L1785
		// But the static segment `InventoryItems` in the resource ID of the Inventory Item returned by API starts with uppercase. So it has to use ParseInventoryItemIDInsensitively() in Read() to normalize the resource ID

Data Source: azurerm_system_center_virtual_machine_manager_inventory_items - normalize the resource ID #25955

Data Source: azurerm_system_center_virtual_machine_manager_inventory_items - normalize the resource ID #25955

Conversation

neil-yechenwei commented May 14, 2024 • edited

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neil-yechenwei commented May 14, 2024

stephybun 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

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

neil-yechenwei commented May 28, 2024

stephybun 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

neil-yechenwei commented May 28, 2024

stephybun left a comment

Choose a reason for hiding this comment

Data Source: `azurerm_system_center_virtual_machine_manager_inventory_items` - normalize the resource ID #25955

Data Source: `azurerm_system_center_virtual_machine_manager_inventory_items` - normalize the resource ID #25955

neil-yechenwei commented May 14, 2024 •

edited