fix: verify & set parent team after creation

[reiniertimmer]

Resolves #1167

Behavior

Before the change?

Using a GitHub App, the parent team is not set (when the parent team was not created by the GitHub App). Effectively, the created team will then be at the root level with a pending approval.

However, the GitHub App should be allowed to nest under parent teams, this just needs an additional call to the REST API update team endpoint.

After the change?

When adding a team with a parent team specified, it will now work the same with GitHub Apps as it works with PATs.

Other information

This change only adds one check:

• if a parent was requested, but the nesting was not created, this change will just re-attempt to create the nesting. This may still mean that the nesting will not be done properly.
• existing tests are only for testing the integration with a PAT. I did not add an additional case using a GitHub App. Maybe that's something can be done separately?

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Added the appropriate label for the given change

Does this introduce a breaking change?

Should not be a breaking change.

• Yes (Please add the Type: Breaking change label)
• No

Pull request type

• Bugfix: Type: Bug

[kfcampbell]

@reiniertimmer would you mind adding a brief code comment describing the need and circumstances around the extra call? I think I'll be confused when looking at this again in the future and a description may be helpful.

[reiniertimmer]

@kfcampbell of course I can do that. Will do that as soon as I have the opportunity.

I must say that the whole behavioural difference in the API is a bit unexpected.

The additional call to set the parent is also not guaranteed to succeed (permission-wise, even with a PAT) which makes this something of a best-effort attempt.

I'll see if I can catch that in a short but meaningful comment 😊

[reiniertimmer]

@kfcampbell I added a comment that hopefully explains what is going on.

This PR resolves an issue specific to using GitHub Apps. Since the contribution section only describes running the provider with a PAT, I'm not sure when (and if) such issues can be caught automatically. Using GitHub Apps for automation also seems like a logical choice in some cases.

Is there anything that can be done to improve the testing with GitHub App tokens as well? Or is that effort already being started here? #1414

[kfcampbell]

Is there anything that can be done to improve the testing with GitHub App tokens as well? Or is that effort already being started here? #1414

The will to do so is there but unfortunately the effort hasn't been started yet. I agree that testing with GitHub Apps would be a great idea and it's something we should do in the future.

[kfcampbell]

I've confirmed that the relevant integration tests are still passing locally on this branch. I'll get this merged and released sometime in the near future; hopefully it'll help ease some of the errors users are seeing.