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_dev_center_project_environment_type #26941

Merged

Conversation

neil-yechenwei
Copy link
Contributor

@neil-yechenwei neil-yechenwei commented Aug 6, 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

This PR is to support new resource Dev Center Project Environment Type.

API Spec: https://github.com/Azure/azure-rest-api-specs/blob/c4a450f92c5a0b0cb70828d3d1588a2e690b80db/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L2128

Overview: https://learn.microsoft.com/en-us/azure/deployment-environments/how-to-configure-project-environment-types

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)

image

Change Log

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

  • New Resource: azurerm_dev_center_project_environment_type

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 #26706

Note

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

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 @neil-yechenwei ,

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

@neil-yechenwei
Copy link
Contributor Author

@ms-zhenhua , thanks for the comments. I updated PR and left suggestion. Please take another look.

@neil-yechenwei
Copy link
Contributor Author

@ms-zhenhua , thanks for the comments. I updated PR. Please take another look. Below is the latest test result I just now triggered. All related test cases passed.
image

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 @neil-yechenwei ,

thank you for your updates. LGTM~

@neil-yechenwei neil-yechenwei marked this pull request as ready for review August 12, 2024 06:06
Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @neil-yechenwei. Please take a look at the comments left in-line. Once those are resolved this should be good to go.

Comment on lines 252 to 255
properties := resp.Model
if properties == nil {
return fmt.Errorf("retrieving %s: `model` was nil", id)
}
Copy link
Member

Choose a reason for hiding this comment

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

In the very unlikely event that Model is returned to us as null, this should be nil checked in the Update as well. For consistency can you please update this to:

Suggested change
properties := resp.Model
if properties == nil {
return fmt.Errorf("retrieving %s: `model` was nil", id)
}
if resp.Model == nil {
return fmt.Errorf("retrieving %s: `model` was nil", id)
}
if resp.Model.Properties == nil {
return fmt.Errorf("retrieving %s: `properties` was nil", id)
}
payload := resp.Model

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

identity_ids = [azurerm_user_assigned_identity.test.id]
}

creator_role_assignment_roles = [split("/", data.azurerm_role_definition.test.id)[length(split("/", data.azurerm_role_definition.test.id)) - 1]]
Copy link
Member

Choose a reason for hiding this comment

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

I think this expression can be replaced by using the role_definition_id since that is the GUID/UUID of the role definition

Suggested change
creator_role_assignment_roles = [split("/", data.azurerm_role_definition.test.id)[length(split("/", data.azurerm_role_definition.test.id)) - 1]]
creator_role_assignment_roles = [data.azurerm_role_definition.test.role_definition_id]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The format of role_definition_id is like "/providers/Microsoft.Authorization/roleDefinitions/xxxx" but this property requires the GUID format. So I assume that we can't use role_definition_id.

image


user_role_assignment {
user_id = azurerm_user_assigned_identity.test.principal_id
roles = [split("/", data.azurerm_role_definition.test.id)[length(split("/", data.azurerm_role_definition.test.id)) - 1]]
Copy link
Member

Choose a reason for hiding this comment

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

Same with this one

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same reason as above.

Comment on lines +236 to +246
creator_role_assignment_roles = [split("/", data.azurerm_role_definition.test.id)[length(split("/", data.azurerm_role_definition.test.id)) - 1], split("/", data.azurerm_role_definition.test2.id)[length(split("/", data.azurerm_role_definition.test2.id)) - 1]]

user_role_assignment {
user_id = azurerm_user_assigned_identity.test.principal_id
roles = [split("/", data.azurerm_role_definition.test.id)[length(split("/", data.azurerm_role_definition.test.id)) - 1], split("/", data.azurerm_role_definition.test2.id)[length(split("/", data.azurerm_role_definition.test2.id)) - 1]]
}

user_role_assignment {
user_id = azurerm_user_assigned_identity.test2.principal_id
roles = [split("/", data.azurerm_role_definition.test2.id)[length(split("/", data.azurerm_role_definition.test2.id)) - 1]]
}
Copy link
Member

Choose a reason for hiding this comment

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

Same with these

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same reason as above.


* `dev_center_project_id` - (Required) The ID of the associated Dev Center Project. Changing this forces a new resource to be created.

* `deployment_target_id` - (Required) The ID of the subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* `deployment_target_id` - (Required) The ID of the subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.
* `deployment_target_id` - (Required) The ID of the subscription that the Environment Type will be mapped to. The environment's resources will be deployed into this subscription.

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

@neil-yechenwei
Copy link
Contributor Author

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

image

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @neil-yechenwei LGTM 👍

@stephybun stephybun merged commit 2f2dfdf into hashicorp:main Aug 14, 2024
34 checks passed
@github-actions github-actions bot added this to the v3.116.0 milestone Aug 14, 2024
stephybun added a commit that referenced this pull request Aug 15, 2024
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for Dev Center Project environment types & Dev Center Project types
3 participants