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

Use graphql rather than rest API for Github team membership #1786

Merged
merged 1 commit into from
Jul 25, 2023

Conversation

joshua9519
Copy link
Contributor

@joshua9519 joshua9519 commented Jul 10, 2023

This change should provide better diffing for team members for teams with child teams. Currently, child team members are included in the parent team's members list and so diffs are incorrect.

See Issue 1193.

Resolves #1193


Behavior

Before the change?

Currently, child team members are included in the parent team's members list and so diffs are incorrect.

Say we have a team team-a, with members user-1 and user-2 and child teams team-b - with user-3 as a member - and team-c - with user-4 as a member - then we expect to see only the members user-1 and user-2 in the diff of team membership resource. However, we instead see user-3 and user-4 in the diff as needing to be removed.

After the change?

Using the graphQL API rather than the rest API for reading the team members allows us to specify that we only want users with immediate membership.

Other information


Additional info

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?

Please see our docs on breaking changes to help!

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

If Yes, what's the impact:

  • N/A

Pull request type

Please add the corresponding label for change this PR introduces:

  • Bugfix: Type: Bug
  • Feature/model/API additions: Type: Feature
  • Updates to docs or samples: Type: Documentation
  • Dependencies/code cleanup: Type: Maintenance

@kfcampbell kfcampbell added the Type: Bug Something isn't working as documented label Jul 13, 2023
@kfcampbell
Copy link
Member

This PR is causing integration test failures for me locally:

    testing.go:705: Step 0 error: Check failed: Check 1/2 error: team has not one member: 0

Can you reproduce this?

@joshua9519
Copy link
Contributor Author

joshua9519 commented Jul 19, 2023

This PR is causing integration test failures for me locally:

    testing.go:705: Step 0 error: Check failed: Check 1/2 error: team has not one member: 0

Can you reproduce this?

Hi @kfcampbell I can run the tests but I feel like I am struggling with the test setup required for this PR because I am seeing that error on the main branch as well as on my branch... I have a test organisation and I even made a test user but can't seem to get the setup to work with the correct env vars etc.

Could I get some guidance?

Thank!

@jsifuentes
Copy link
Contributor

Hi. I ran into the issue that required this PR, so I'm interested in getting this merged. I ran the acceptance test locally and ran into the same issue @kfcampbell described, but I think the issue stems from the fact that team membership is not returned on the API if organization membership has not been accepted yet. This comment in the original PR for github_team_members also shows that testing this feature was not straightforward back when it was merged: #975 (review)

Gave this a spin locally but found it difficult to test given the whole invite-another-collaborator flow. Looks good on another read through though and feel we can ship and iterate if needed.

The way I got my acceptance test to run successfully locally is by setting env GITHUB_TEST_COLLABORATOR to a user that already exists in the organization as a member. Then when the API returns team membership, it seems to appear correct and the test passes.

@joshua9519
Copy link
Contributor Author

I can confirm that @jsifuentes is absolutely right and the only way to make this test work is by using a user that you have already added to the organization as a member. I have done this and it works and tests pass. I'm not sure how the maintainers wish to proceed on this.

@kfcampbell do you have any thoughts?

This change should provide better diffing for team membership for teams
with child teams. Currently, child team members are included in the parent
team's members list and so diffs are incorrect.

See [Issue 1193](integrations#1193).
@kfcampbell
Copy link
Member

Thank you both! I've been able to confirm acceptance tests are passing now. I appreciate the work here!

@kfcampbell kfcampbell merged commit 3159217 into integrations:main Jul 25, 2023
3 checks passed
@csainty
Copy link
Contributor

csainty commented Aug 18, 2023

This doesn't appear to do paging, cutting off teams at 100 members and making the plan think it needs to add a bunch of new members.
Investigating a fix locally, but I'm no Go expert and lack a ready test environment. So sending a heads up.

o-sama pushed a commit to o-sama/terraform-provider-github that referenced this pull request Aug 19, 2023
…ions#1786)

This change should provide better diffing for team membership for teams
with child teams. Currently, child team members are included in the parent
team's members list and so diffs are incorrect.

See [Issue 1193](integrations#1193).
o-sama added a commit to o-sama/terraform-provider-github that referenced this pull request Aug 19, 2023
Add docs, update tests, small changes to rulesets

octoherd: delete pull_request_template.md

feat: add pull_request_template.md PR template

feat: add data source to get organization members' SAML/SCIM linked identities (integrations#1778)

* add `github_organization_external_identities` which returns a list of github organization members and their SAML linked identity

* add docs

* add more fields to external_identities

* docs

---------

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

fix: Github Environments Policy feature causing the provider to produce inconsistent result (integrations#1799)

* Add deployment policy resource

- Add the initial code to manage the resource
- Add sample configuration used to test it

TODO
- Documentation
- Tests

* Add schema description

* Fix creation of resource ID

* Add tests

* Add documentation

* Add terraform import support

* Undo example add

* Fix formatting

* PR feedback

* fix: environment branch policy failing to find the created resource

The `Read` operation of the Environments Branch Policy resource
was failing to find the newly created Branch policies, due to
wrongly encoded environment name. Which cause the provider to
be inconsistent.

This fix uses `url.PathEscape` instead of `url.QueryEscape`
since we are using path parameters with the Github API in
that case. Additionally 2 operations - `Read` and `Delete`
don't need to use it as they receive the environment name
already parsed and attempting to encode it again breaks the
name.

* Fix incorrect merge

---------

Co-authored-by: Massimiliano Donini <massimiliano.donini@gmail.com>
Co-authored-by: Keegan Campbell <me@kfcampbell.com>

Enforce valid chars in repo name (integrations#1806)

* Enforce valid chars in repo name

Signed-off-by: Benoit Donneaux <ben@tergology.com>

* Add dash to validate repo name

Signed-off-by: Benoit Donneaux <ben@tergology.com>

* Better name validation message

Signed-off-by: Benoit Donneaux <ben@tergology.com>

* Test repo name max length

Signed-off-by: Benoit Donneaux <ben@tergology.com>

* Test space in repo name

Signed-off-by: Benoit Donneaux <ben@tergology.com>

---------

Signed-off-by: Benoit Donneaux <ben@tergology.com>
Co-authored-by: Keegan Campbell <me@kfcampbell.com>

Use graphql rather than rest API for Github team membership (integrations#1786)

This change should provide better diffing for team membership for teams
with child teams. Currently, child team members are included in the parent
team's members list and so diffs are incorrect.

See [Issue 1193](integrations#1193).

feat: add immediate-response.yml auto responder workflow

build(deps): bump peter-evans/create-or-update-comment

Bumps [peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment) from 6534843181fc2aeb7f9f1cd3cd4a7b956cada2db to 716151b9579b05352dbf244d48e968d211889bbc.
- [Release notes](https://github.com/peter-evans/create-or-update-comment/releases)
- [Commits](peter-evans/create-or-update-comment@6534843...716151b)

---
updated-dependencies:
- dependency-name: peter-evans/create-or-update-comment
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

Add Codespaces Organization Secret Repositories Resource.

Add depends_on to prevent branch policy being created before the corresponding environment (which results in an error), add more detail about the error thrown if deployment_branch_policy.custom_branch_policies is not set to true, tf fmt example

build(deps): bump peter-evans/create-or-update-comment (integrations#1830)

Bumps [peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment) from 716151b9579b05352dbf244d48e968d211889bbc to 38217c6b94b54c0dbbe75be237257364e2dd2e62.
- [Release notes](https://github.com/peter-evans/create-or-update-comment/releases)
- [Commits](peter-evans/create-or-update-comment@716151b...38217c6)

---
updated-dependencies:
- dependency-name: peter-evans/create-or-update-comment
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

build(deps): bump golang.org/x/crypto from 0.11.0 to 0.12.0 (integrations#1829)

Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.11.0 to 0.12.0.
- [Commits](golang/crypto@v0.11.0...v0.12.0)

---
updated-dependencies:
- dependency-name: golang.org/x/crypto
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Keegan Campbell <me@kfcampbell.com>

build(deps): bump golang.org/x/oauth2 from 0.10.0 to 0.11.0 (integrations#1828)

Bumps [golang.org/x/oauth2](https://github.com/golang/oauth2) from 0.10.0 to 0.11.0.
- [Commits](golang/oauth2@v0.10.0...v0.11.0)

---
updated-dependencies:
- dependency-name: golang.org/x/oauth2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

fix: `github_repository_collaborators` - mark `invitation_ids` as changed when new user invited (integrations#1825)

* fix: mark invitation_ids as changed if new user is invited

* fix: documentation

---------

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

feat: expose SAML external identity exposed for GitHub user  (integrations#1796)

* create github_user_external_identity datasource

* add scim information and error handling for bad username org combo

* cleanup commentzs

* add docs for external identity

* move external identity to its own struct

* add variable to make referencing external identity easier

* add test

* add documentation

* remove old docs

* add docs reference in github.erb

---------

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

Do not change squash_merge/merge_commit if it is not allowed in conf (integrations#1834)

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

build(deps): bump peter-evans/create-or-update-comment

Bumps [peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment) from 38217c6b94b54c0dbbe75be237257364e2dd2e62 to 5f22cb87da9514ab329de42e5462372dc19928a5.
- [Release notes](https://github.com/peter-evans/create-or-update-comment/releases)
- [Commits](peter-evans/create-or-update-comment@38217c6...5f22cb8)

---
updated-dependencies:
- dependency-name: peter-evans/create-or-update-comment
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

add primary_language to repository datasource

add primary_language to repository resource

add test to repository datasource

add docs for primary_language change

add test for resource

update name of testcase

run linting

update comment

Update to go-github v54
avidspartan1 pushed a commit to avidspartan1/terraform-provider-github that referenced this pull request Feb 5, 2024
…ions#1786)

This change should provide better diffing for team membership for teams
with child teams. Currently, child team members are included in the parent
team's members list and so diffs are incorrect.

See [Issue 1193](integrations#1193).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TF tries to remove members of the subteam from the parent team even though they dont exist in it.
4 participants