Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new resource azurerm_stack_hci_network_interface #26888

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

teowa
Copy link
Contributor

@teowa teowa commented Jul 31, 2024

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 comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

new resource azurerm_stack_hci_network_interface
swagger: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2024-01-01/networkInterfaces.json
azure doc: https://learn.microsoft.com/en-us/azure-stack/hci/manage/create-network-interfaces?tabs=azurecli

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)
--- PASS: TestAccStackHCINetworkInterface_dynamic (510.08s)
--- PASS: TestAccStackHCINetworkInterface_complete (547.78s)
--- PASS: TestAccStackHCINetworkInterface_update (763.11s)
--- PASS: TestAccStackHCINetworkInterface_requiresImport (1010.17s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/azurestackhci 1010.193s

Change Log

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

  • new resource azurerm_stack_hci_network_interface

This is a (please select all that apply):

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

Related Issue(s)

Fixes #0000

Note

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

@teowa
Copy link
Contributor Author

teowa commented Oct 22, 2024

image
log

Copy link
Contributor

@ms-zhenhua ms-zhenhua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @teowa,

Thanks for this PR - I've taken a look through and left some minor comments inline. If we can fix those up, this should be good to go 👍

ForceNew: true,
ValidateFunc: validation.StringMatch(
regexp.MustCompile(`^[a-zA-Z0-9][\-\.\_a-zA-Z0-9]{0,78}[a-zA-Z0-9]$`),
"name must be between 2 and 80 characters and can only contain alphanumberic characters, hyphen, dot and underline",
Copy link
Contributor

@ms-zhenhua ms-zhenhua Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"name must be between 2 and 80 characters and can only contain alphanumberic characters, hyphen, dot and underline",
"name must be between 2 and 80 characters and can only contain alphanumberic characters, hyphens(-), periods(.) and underlines(_). It must begin and end with alphanumberic characters.",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated


type StackHCINetworkInterfaceResource struct{}

func TestAccStackHCINetworkInterface_dynamic(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not name it basic ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated


* `location` - (Required) The Azure Region where the Azure Stack HCI Network Interface should exist. Changing this forces a new resource to be created.

* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Network Interface should exist. Changing this forces a new resource to be created.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `custom_location_id` - (Required) The ID of Custom Location where the Azure Stack HCI Network Interface should exist. Changing this forces a new resource to be created.
* `custom_location_id` - (Required) The ID of the Custom Location where the Azure Stack HCI Network Interface should exist. Changing this forces a new resource to be created.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated


* `id` - The resource ID of the Azure Stack HCI Network Interface.

* `ip_configuration` - A `ip_configuration` as defined below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `ip_configuration` - A `ip_configuration` as defined below.
* `ip_configuration` - An `ip_configuration` as defined below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@teowa
Copy link
Contributor Author

teowa commented Oct 24, 2024

Hi @ms-zhenhua , thanks for reviewing. I have updated the code, please take another look.

Copy link
Contributor

@ms-zhenhua ms-zhenhua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @teowa,

Thank you for your updates. LGTM~

@teowa teowa marked this pull request as ready for review October 24, 2024 08:35
@teowa teowa requested a review from katbyte as a code owner October 24, 2024 08:35
@teowa teowa requested a review from a team as a code owner October 24, 2024 08:35

* `mac_address` - (Optional) The MAC address of the Network Interface. Changing this forces a new resource to be created.

-> **Note:** If `mac_address` is not specified, it will be assigned by the server. If you experience a diff you may need to add this to `ignore_changes`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason we do not make this computed so the user doesn't have to ue ignore changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the contribute doc,

In order to solve this, (new) fields should no longer be marked as Optional + Computed - instead where a split Create and Update method is used (see above) users can lean on ignore_changes to ignore values from a field with a default value, should they wish to continue using the default value.

seems we are supposed to avoid optional+computed for new field.

ForceNew: true,
ValidateFunc: validation.StringMatch(
regexp.MustCompile(`^[a-zA-Z0-9][\-\.\_a-zA-Z0-9]{0,78}[a-zA-Z0-9]$`),
"name must be between 2 and 80 characters and can only contain alphanumberic characters, hyphens(-), periods(.) and underlines(_). It must begin and end with an alphanumberic character.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would something like this be more clear?

Suggested change
"name must be between 2 and 80 characters and can only contain alphanumberic characters, hyphens(-), periods(.) and underlines(_). It must begin and end with an alphanumberic character.",
"name must begin and end with an alphanumeric character, be between 2 and 80 characters in length and can only contain alphanumeric characters, hyphens, periods or underscores.",

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@teowa, sorry I forgot to add the description to my review. I took a look a think this mostly LGTM. If we can get the validation function error message fixed up I think this would be GTG! 🚀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reviewing this, the code is updated, please kindly take another look.

Copy link
Collaborator

@WodansSon WodansSon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @teowa,

Thanks for pushing those changes! I have given the PR another look at this LGTM now! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants