Merge pull request #941 from timofurrer/bugfix/deploy-tokens-pagination

resource/gitlab_deploy_token: Implement pagination when reading tokens

Author: timofurrer

internal/provider/resource_gitlab_deploy_token.go

@@ -165,40 +165,63 @@ func resourceGitlabDeployTokenRead(ctx context.Context, d *schema.ResourceData,
 		return diag.FromErr(err)
 	}
 
-	var deployTokens []*gitlab.DeployToken
+	var deployToken *gitlab.DeployToken
+
+	extractDeployToken := func(paginatedDeployTokens []*gitlab.DeployToken) *gitlab.DeployToken {
+		for _, token := range paginatedDeployTokens {
+			if token.ID == deployTokenID {
+				return token
+			}
+		}
+		return nil
+	}
 
 	if isProject {
 		log.Printf("[DEBUG] Read GitLab deploy token %d in project %s", deployTokenID, project.(string))
-		deployTokens, _, err = client.DeployTokens.ListProjectDeployTokens(project, nil, gitlab.WithContext(ctx))
-
+		options := gitlab.ListProjectDeployTokensOptions{
+			Page:    1,
+			PerPage: 20,
+		}
+		for options.Page != 0 && deployToken == nil {
+			paginatedDeployTokens, resp, err := client.DeployTokens.ListProjectDeployTokens(project, &options, gitlab.WithContext(ctx))
+			if err != nil {
+				return diag.FromErr(err)
+			}
+			deployToken = extractDeployToken(paginatedDeployTokens)
+			options.Page = resp.NextPage
+		}
 	} else if isGroup {
 		log.Printf("[DEBUG] Read GitLab deploy token %d in group %s", deployTokenID, group.(string))
-		deployTokens, _, err = client.DeployTokens.ListGroupDeployTokens(group, nil, gitlab.WithContext(ctx))
-	}
-	if err != nil {
-		return diag.FromErr(err)
-	}
-
-	for _, token := range deployTokens {
-		if token.ID == deployTokenID {
-			d.Set("name", token.Name)
-			d.Set("username", token.Username)
-
-			if token.ExpiresAt != nil {
-				d.Set("expires_at", token.ExpiresAt.Format(time.RFC3339))
-			}
-
-			if err := d.Set("scopes", token.Scopes); err != nil {
+		options := gitlab.ListGroupDeployTokensOptions{
+			Page:    1,
+			PerPage: 20,
+		}
+		for options.Page != 0 && deployToken == nil {
+			paginatedDeployTokens, resp, err := client.DeployTokens.ListGroupDeployTokens(group, &options, gitlab.WithContext(ctx))
+			if err != nil {
 				return diag.FromErr(err)
 			}
-
-			return nil
+			deployToken = extractDeployToken(paginatedDeployTokens)
+			options.Page = resp.NextPage
 		}
 	}
 
-	log.Printf("[DEBUG] GitLab deploy token %d in group %s was not found", deployTokenID, group.(string))
+	if deployToken == nil {
+		log.Printf("[DEBUG] GitLab deploy token %d in was not found, removing from state", deployTokenID)
+		d.SetId("")
+		return nil
+	}
 
-	d.SetId("")
+	d.Set("name", deployToken.Name)
+	d.Set("username", deployToken.Username)
+
+	if deployToken.ExpiresAt != nil {
+		d.Set("expires_at", deployToken.ExpiresAt.Format(time.RFC3339))
+	}
+
+	if err := d.Set("scopes", deployToken.Scopes); err != nil {
+		return diag.FromErr(err)
+	}
 
 	return nil
 }

internal/provider/resource_gitlab_deploy_token_test.go

@@ -33,6 +33,30 @@ func TestAccGitlabDeployToken_basic(t *testing.T) {
 		},
 	})
 }
+func TestAccGitlabDeployToken_pagination(t *testing.T) {
+	testAccCheck(t)
+
+	testGroup := testAccCreateGroups(t, 1)[0]
+	testProject := testAccCreateProject(t)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		CheckDestroy:      testAccCheckGitlabDeployTokenDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccGitlabDeployTokenPaginationConfig(25, testGroup.ID, testProject.ID),
+			},
+			// In case pagination wouldn't properly work, we would get that the plan isn't empty,
+			// because some of the deploy tokens wouldn't be in the first page and therefore
+			// considered non-existing, ...
+			{
+				Config:   testAccGitlabDeployTokenPaginationConfig(25, testGroup.ID, testProject.ID),
+				PlanOnly: true,
+			},
+		},
+	})
+}
 
 func testAccCheckGitlabDeployTokenExists(n string, deployToken *gitlab.DeployToken) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
@@ -163,6 +187,26 @@ resource "gitlab_deploy_token" "foo" {
   `, rInt, rInt)
 }
 
+func testAccGitlabDeployTokenPaginationConfig(numberOfTokens int, groupID int, projectID int) string {
+	return fmt.Sprintf(`
+resource "gitlab_deploy_token" "example_group" {
+  group  = %d
+  name   = "deploy-token-${count.index}"
+  scopes = ["read_registry"]
+
+  count = %d
+}
+
+resource "gitlab_deploy_token" "example_project" {
+  project  = %d
+  name   = "deploy-token-${count.index}"
+  scopes = ["read_registry"]
+
+  count = %d
+}
+  `, groupID, numberOfTokens, projectID, numberOfTokens)
+}
+
 type expiresAtSuppressFuncTest struct {
 	description string
 	old         string