Teams: Skip team synced members when reading team status (#702)

* skip team synced members

* add flag that allows skipping team synced members

* generate docs for the new field

* update Golang API client dependency

* fix tests

* fix broken link

* fix tests attempt 2

* uncomment test conditionals

Author: IevaVasiljeva

docs/resources/team.md

@@ -33,6 +33,9 @@ resource "grafana_team" "test-team" {
 ### Optional
 
 - `email` (String) An email address for the team.
+- `ignore_externally_synced_members` (Boolean) Ignores team members that have been added to team by [Team Sync](https://grafana.com/docs/grafana/latest/enterprise/team-sync/).
+Team Sync can be provisioned using [grafana_team_external_group resource](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/team_external_group).
+ Defaults to `true`.
 - `members` (Set of String) A set of email addresses corresponding to users who should be given membership
 to the team. Note: users specified here must already exist in Grafana.
 

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/Masterminds/semver/v3 v3.1.1
 	github.com/grafana/amixr-api-go-client v0.0.5
-	github.com/grafana/grafana-api-golang-client v0.12.1
+	github.com/grafana/grafana-api-golang-client v0.13.0
 	github.com/grafana/machine-learning-go-client v0.1.1
 	github.com/grafana/synthetic-monitoring-agent v0.9.4
 	github.com/grafana/synthetic-monitoring-api-go-client v0.6.3

go.sum

@@ -115,8 +115,8 @@ github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/grafana/amixr-api-go-client v0.0.5 h1:jqmljnd5FozuOsCNuyhZVpooxmj0BW9MmeLA7PaLK6U=
 github.com/grafana/amixr-api-go-client v0.0.5/go.mod h1:N6x26XUrM5zGtK5zL5vNJnAn2JFMxLFPPLTw/6pDkFE=
-github.com/grafana/grafana-api-golang-client v0.12.1 h1:GLkNXslTWf/ZBxjRHK6VYW6FSqFnhaiA47pTZe9GUBw=
-github.com/grafana/grafana-api-golang-client v0.12.1/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
+github.com/grafana/grafana-api-golang-client v0.13.0 h1:o/gL3F7EjBSBKgrpjH9/+sYFJ0HBUofvAYlKhrT2opE=
+github.com/grafana/grafana-api-golang-client v0.13.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/machine-learning-go-client v0.1.1 h1:Gw6cX8xAd6IVF2LApkXOIdBK8Gzz07B3jQPukecw7fc=
 github.com/grafana/machine-learning-go-client v0.1.1/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
 github.com/grafana/synthetic-monitoring-agent v0.9.4 h1:Enx5s6gFbc/RAzL5KDX/00catAlbcY7/1IFPBe5lo/c=

grafana/resource_team.go

@@ -69,6 +69,15 @@ func ResourceTeam() *schema.Resource {
 				Description: `
 A set of email addresses corresponding to users who should be given membership
 to the team. Note: users specified here must already exist in Grafana.
+`,
+			},
+			"ignore_externally_synced_members": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  true,
+				Description: `
+Ignores team members that have been added to team by [Team Sync](https://grafana.com/docs/grafana/latest/enterprise/team-sync/).
+Team Sync can be provisioned using [grafana_team_external_group resource](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/team_external_group).
 `,
 			},
 		},
@@ -158,6 +167,11 @@ func ReadMembers(d *schema.ResourceData, meta interface{}) error {
 		if teamMember.Email == "admin@localhost" {
 			continue
 		}
+		// Labels store information about auth provider used to sync the team member.
+		// Team synced members should be managed through team_external_group resource and should be ignored here.
+		if d.Get("ignore_externally_synced_members").(bool) && len(teamMember.Labels) > 0 {
+			continue
+		}
 		memberSlice = append(memberSlice, teamMember.Email)
 	}
 	d.Set("members", memberSlice)

grafana/resource_team_test.go

@@ -47,9 +47,10 @@ func TestAccTeam_basic(t *testing.T) {
 				),
 			},
 			{
-				ResourceName:      "grafana_team.test",
-				ImportState:       true,
-				ImportStateVerify: true,
+				ResourceName:            "grafana_team.test",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_externally_synced_members"},
 			},
 		},
 	})
@@ -102,9 +103,10 @@ func TestAccTeam_Members(t *testing.T) {
 			},
 			// Test the import with members
 			{
-				ResourceName:      "grafana_team.test",
-				ImportState:       true,
-				ImportStateVerify: true,
+				ResourceName:            "grafana_team.test",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"ignore_externally_synced_members"},
 			},
 			{
 				Config: testAccTeamConfig_memberRemove,