Gitlab enterprise polling (#129)

* implement polling of gitlab enterprise repo to handle lengthy sync phase during onboarding

* add docs

* use interval as const

Author: amiros89

client/models.go

@@ -560,3 +560,21 @@ type RepoUpdate struct {
 	Agents         []string `json:"agents"`
 	UseAllAgents   bool     `json:"use_all_agents"`
 }
+
+type RepoDetails struct {
+	Name           string   `json:"name"`
+	URL            string   `json:"repository_url"`
+	Token          *string  `json:"token"`
+	Branch         string   `json:"branch"`
+	CredentialName string   `json:"credential_name"`
+	UseAllAgents   bool     `json:"use_all_agents"`
+	Agents         []Agents `json:"agents"`
+	Status         string   `json:"status"`
+	SpaceName      string   `json:"space_name"`
+	Errors         []Error  `json:"errors"`
+}
+
+type Agents struct {
+	Name   string `json:"name"`
+	Status string `json:"status"`
+}

client/repository.go

@@ -188,3 +188,27 @@ func (c *Client) UpdateRepoConfiguration(space_name string, repo_name string, cr
 
 	return nil
 }
+
+func (c *Client) GetRepoDetails(space_name string, repo_name string) (*RepoDetails, error) {
+	req, err := http.NewRequest("GET", fmt.Sprintf("%sapi/spaces/%s/repositories", c.HostURL, space_name), nil)
+	if err != nil {
+		return nil, err
+	}
+	body, err := c.doRequest(req, &c.Token)
+	if err != nil {
+		return nil, err
+	}
+	repos := []RepoDetails{}
+	err = json.Unmarshal(body, &repos)
+	if err != nil {
+		return nil, err
+	}
+	repo := RepoDetails{}
+	for _, repo_item := range repos {
+		if repo_name == repo_item.Name {
+			repo = repo_item
+			return &repo, nil
+		}
+	}
+	return nil, fmt.Errorf("repository %s not found", repo_name)
+}

docs/resources/gitlab_enterprise_repository_space_association.md

@@ -36,6 +36,7 @@ resource "torque_gitlab_enterprise_repository_space_association" "repository" {
   credential_name = "credentials"
   use_all_agents  = false
   agents          = ["eks", "aks"]
+  timeout         = 5
 }
 ```
 
@@ -53,5 +54,6 @@ resource "torque_gitlab_enterprise_repository_space_association" "repository" {
 ### Optional
 
 - `agents` (List of String) List of specific agents to use to onboard and sync this repository. Cannot be specified when use_all_agents is true.
+- `timeout` (Number) Time in minutes to wait for Torque to sync the repository during the onboarding. Default is 1 minute.
 - `token` (String, Deprecated) Authentication Token to the project/repository. If omitted, existing credentials provided in the credential_name field will be used for authentication. If provided, a new credentials object will be created.
 - `use_all_agents` (Boolean) Whether all associated agents can be used to onboard and sync this repository. Must be set to false if agents attribute is used.

examples/resources/torque_gitlab_enterprise_repository_space_association/resource.tf

@@ -21,4 +21,5 @@ resource "torque_gitlab_enterprise_repository_space_association" "repository" {
   credential_name = "credentials"
   use_all_agents  = false
   agents          = ["eks", "aks"]
+  timeout         = 5
 }

examples/resources/torque_gitlab_enterprise_repository_space_association/variables.tf

@@ -55,3 +55,9 @@ variable "agents" {
   type        = string
   description = "List of specific agents to use to onboard and sync this repository. Cannot be specified when use_all_agents is true."
 }
+
+variable "timeout" {
+  type        = number
+  description = "Time in minutes to wait for Torque to sync the repository during the onboarding. Default is 1 minute."
+  default     = 1
+}

internal/provider/resources/space_gitlab_enterprise_repository_resource.go

@@ -4,16 +4,17 @@ import (
 	"context"
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/int32default"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/qualitorque/terraform-provider-torque/client"
 )
 
@@ -39,6 +40,7 @@ type TorqueSpaceGitlabEnterpriseRepositoryResourceModel struct {
 	CredentialName types.String `tfsdk:"credential_name"`
 	UseAllAgents   types.Bool   `tfsdk:"use_all_agents"`
 	Agents         types.List   `tfsdk:"agents"`
+	TimeOut        types.Int32  `tfsdk:"timeout"`
 }
 
 func (r *TorqueSpaceGitlabEnterpriseRepositoryResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
@@ -103,6 +105,13 @@ func (r *TorqueSpaceGitlabEnterpriseRepositoryResource) Schema(ctx context.Conte
 				Optional:    true,
 				ElementType: types.StringType,
 			},
+			"timeout": schema.Int32Attribute{
+				Description: "Time in minutes to wait for Torque to sync the repository during the onboarding. Default is 1 minute.",
+				Required:    false,
+				Optional:    true,
+				Computed:    true,
+				Default:     int32default.StaticInt32(1),
+			},
 		},
 	}
 }
@@ -129,7 +138,11 @@ func (r *TorqueSpaceGitlabEnterpriseRepositoryResource) Configure(ctx context.Co
 
 func (r *TorqueSpaceGitlabEnterpriseRepositoryResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	var data TorqueSpaceGitlabEnterpriseRepositoryResourceModel
-
+	const (
+		StatusSyncing   = "Syncing"
+		StatusConnected = "Connected"
+		Interval        = 4 * time.Second
+	)
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
 
 	if resp.Diagnostics.HasError() {
@@ -141,16 +154,35 @@ func (r *TorqueSpaceGitlabEnterpriseRepositoryResource) Create(ctx context.Conte
 			agents = append(agents, strings.Trim(agent.String(), "\""))
 		}
 	}
+	start := time.Now()
 	err := r.client.OnboardGitlabEnterpriseRepoToSpace(data.SpaceName.ValueString(), data.RepositoryName.ValueString(),
 		data.RepositoryUrl.ValueString(), data.Token.ValueStringPointer(), data.Branch.ValueString(), data.CredentialName.ValueString(), agents, data.UseAllAgents.ValueBool())
 	if err != nil {
+		repo, err := r.client.GetRepoDetails(data.SpaceName.ValueString(), data.RepositoryName.ValueString())
+		if repo == nil {
+			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to onboard repository to space, got error: %s", err))
+			return
+		}
+		if repo.Status == StatusSyncing {
+			timeout := time.Duration(data.TimeOut.ValueInt32()) * time.Minute
+			for time.Since(start) < timeout {
+				repo, err := r.client.GetRepoDetails(data.SpaceName.ValueString(), data.RepositoryName.ValueString())
+				if err != nil {
+					resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Error while polling repository status: %s", err))
+					return
+				}
+				if repo.Status == StatusConnected {
+					resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+					return
+				}
+				time.Sleep(Interval)
+			}
+			resp.Diagnostics.AddError("Sync Timeout", "Timed out while syncing repository")
+			return
+		}
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to onboard repository to space, got error: %s", err))
 		return
 	}
-
-	tflog.Trace(ctx, "Resource Created Successful!")
-
-	// Save data into Terraform state.
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }