gitlab_project_access_token: Test bugfix and destroy improvement

- Fixed a test bug where a hardcoded expiration date that passed caused failures
- Improved the destroy function to wait for the token to finish deleting

Author: armsnyder

internal/provider/resource_gitlab_project_access_token.go

@@ -2,12 +2,14 @@ package provider
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"log"
 	"strconv"
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	gitlab "github.com/xanzy/go-gitlab"
@@ -140,7 +142,6 @@ func resourceGitlabProjectAccessTokenCreate(ctx context.Context, d *schema.Resou
 }
 
 func resourceGitlabProjectAccessTokenRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-
 	project, PATstring, err := parseTwoPartID(d.Id())
 	if err != nil {
 		return diag.Errorf("Error parsing ID: %s", d.Id())
@@ -155,6 +156,73 @@ func resourceGitlabProjectAccessTokenRead(ctx context.Context, d *schema.Resourc
 
 	log.Printf("[DEBUG] read gitlab ProjectAccessToken %d, project ID %s", projectAccessTokenID, project)
 
+	projectAccessToken, err := resourceGitlabProjectAccessTokenFind(ctx, client, project, projectAccessTokenID)
+	if errors.Is(err, errResourceGitlabProjectAccessTokenNotFound) {
+		log.Printf("[DEBUG] failed to read gitlab ProjectAccessToken %d, project ID %s", projectAccessTokenID, project)
+		d.SetId("")
+	}
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.Set("project", project)
+	d.Set("name", projectAccessToken.Name)
+	if projectAccessToken.ExpiresAt != nil {
+		d.Set("expires_at", projectAccessToken.ExpiresAt.String())
+	}
+	d.Set("active", projectAccessToken.Active)
+	d.Set("created_at", projectAccessToken.CreatedAt.String())
+	d.Set("revoked", projectAccessToken.Revoked)
+	d.Set("user_id", projectAccessToken.UserID)
+	d.Set("access_level", accessLevelValueToName[projectAccessToken.AccessLevel])
+	err = d.Set("scopes", projectAccessToken.Scopes)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	return nil
+}
+
+func resourceGitlabProjectAccessTokenDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	project, patString, err := parseTwoPartID(d.Id())
+	if err != nil {
+		return diag.Errorf("Error parsing ID: %s", d.Id())
+	}
+
+	client := meta.(*gitlab.Client)
+
+	projectAccessTokenID, err := strconv.Atoi(patString)
+	if err != nil {
+		return diag.Errorf("%s cannot be converted to int", patString)
+	}
+
+	log.Printf("[DEBUG] Delete gitlab ProjectAccessToken %s", d.Id())
+	_, err = client.ProjectAccessTokens.DeleteProjectAccessToken(project, projectAccessTokenID, gitlab.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	log.Printf("[DEBUG] Waiting for ProjectAccessToken %s to finish deleting", d.Id())
+
+	err = resource.RetryContext(ctx, 5*time.Minute, func() *resource.RetryError {
+		_, err := resourceGitlabProjectAccessTokenFind(ctx, client, project, projectAccessTokenID)
+		if errors.Is(err, errResourceGitlabProjectAccessTokenNotFound) {
+			return nil
+		}
+		if err != nil {
+			return resource.NonRetryableError(err)
+		}
+		return resource.RetryableError(errors.New("project access token was not deleted"))
+	})
+
+	return diag.FromErr(err)
+}
+
+var errResourceGitlabProjectAccessTokenNotFound = errors.New("project access token not found")
+
+// resourceGitlabProjectAccessTokenFind finds the project access token with the specified tokenID.
+// It returns a errResourceGitlabProjectAccessTokenNotFound error if the token is not found.
+func resourceGitlabProjectAccessTokenFind(ctx context.Context, client *gitlab.Client, project interface{}, projectAccessTokenID int) (*gitlab.ProjectAccessToken, error) {
 	//there is a slight possibility to not find an existing item, for example
 	// 1. item is #101 (ie, in the 2nd page)
 	// 2. I load first page (ie. I don't find my target item)
@@ -167,55 +235,17 @@ func resourceGitlabProjectAccessTokenRead(ctx context.Context, d *schema.Resourc
 	for page != 0 {
 		projectAccessTokens, response, err := client.ProjectAccessTokens.ListProjectAccessTokens(project, &gitlab.ListProjectAccessTokensOptions{Page: page, PerPage: 100}, gitlab.WithContext(ctx))
 		if err != nil {
-			return diag.FromErr(err)
+			return nil, err
 		}
 
 		for _, projectAccessToken := range projectAccessTokens {
 			if projectAccessToken.ID == projectAccessTokenID {
-
-				d.Set("project", project)
-				d.Set("name", projectAccessToken.Name)
-				if projectAccessToken.ExpiresAt != nil {
-					d.Set("expires_at", projectAccessToken.ExpiresAt.String())
-				}
-				d.Set("active", projectAccessToken.Active)
-				d.Set("created_at", projectAccessToken.CreatedAt.String())
-				d.Set("revoked", projectAccessToken.Revoked)
-				d.Set("user_id", projectAccessToken.UserID)
-				d.Set("access_level", accessLevelValueToName[projectAccessToken.AccessLevel])
-
-				err = d.Set("scopes", projectAccessToken.Scopes)
-				if err != nil {
-					return diag.FromErr(err)
-				}
-
-				return nil
+				return projectAccessToken, nil
 			}
 		}
 
 		page = response.NextPage
 	}
 
-	log.Printf("[DEBUG] failed to read gitlab ProjectAccessToken %d, project ID %s", projectAccessTokenID, project)
-	d.SetId("")
-	return nil
-}
-
-func resourceGitlabProjectAccessTokenDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-
-	project, PATstring, err := parseTwoPartID(d.Id())
-	if err != nil {
-		return diag.Errorf("Error parsing ID: %s", d.Id())
-	}
-
-	client := meta.(*gitlab.Client)
-
-	projectAccessTokenID, err := strconv.Atoi(PATstring)
-	if err != nil {
-		return diag.Errorf("%s cannot be converted to int", PATstring)
-	}
-
-	log.Printf("[DEBUG] Delete gitlab ProjectAccessToken %s", d.Id())
-	_, err = client.ProjectAccessTokens.DeleteProjectAccessToken(project, projectAccessTokenID, gitlab.WithContext(ctx))
-	return diag.FromErr(err)
+	return nil, errResourceGitlabProjectAccessTokenNotFound
 }