adds entitlment error message for creating Teams #418
Conversation
|
|
| "Error creating team %s for organization %s: %v", name, organization, err) | ||
| if err == tfe.ErrResourceNotFound { | ||
| entitlements, _ := tfeClient.Organizations.Entitlements(ctx, organization) | ||
| if !entitlements.Teams { |
There was a problem hiding this comment.
a panic might happen here if entitlements is nil, so it may be best to check for the error return value here before dereferencing entitlements
It may be interesting to eventually pull entitlements up front so that all resources could short circuit with a helpful error message some day. I didn't know about this API. I'll look into it!
There was a problem hiding this comment.
Do you know how I could test this edge case in staging? I'm new to the product so it's not clear to me how entitlements could be nil
There was a problem hiding this comment.
It could be something as simple as the API returns a 500 or a 503. If an organization has zero entitlements, that would be a huge problem and beyond the scope of the provider.
I don't think an explicit test is necessary; simply having a block that handles the error and returns a clear error msg is sufficient.
There was a problem hiding this comment.
I would just fall through and let the 404 error be returned
There was a problem hiding this comment.
gotcha! that makes a lot of sense. thanks for clarifying that 😊. Just pushed changes for this feedback
Description
This PR resolves Issue 171. Previously when a User on the Free Tier tried to create a team using the tfe provider, the CLI would return an error message like :
Error: Error creating team my-team-name for organization raoul-staging: resource not found. This error does not explain to the user that they cannot create a team because the Free tier does not have the proper entitlements.These changes check entitlements after the
ErrResourceNotFounderror and if there is an error surfaces an error message like:Error creating team my-team-name for organization raoul-staging: missing entitlements to create teamsTesting plan
terraform applyto create a team in the Org - This should surface an error due to entitlementsapply- This should not surface any error.