feat: use sdk for graphql requests as well

update the gitlab golang sdk to a version that now supports the graphql client requests
allows for proper retry strategy
add unit test on graphql based functions
remove all linked graphql classes that are now irrelevant

Author: BoxBoxJason

README.md

@@ -64,7 +64,7 @@ If mandatory arguments are not provided, the program will prompt for them.
 | `--destination-token` | `DESTINATION_GITLAB_TOKEN` | Yes | Access token for the destination GitLab instance |
 | `--destination-big` | `DESTINATION_GITLAB_BIG` | No | Specify if the destination GitLab instance is a big instance (default: false) |
 | `--mirror-mapping` | `MIRROR_MAPPING` | Yes | Path to a JSON file containing the mirror mapping |
-| `--retry` or `-r` | N/A | No | Number of retries for failed GitLab API requests (does not apply to GraphQL requests) (default: 3) |
+| `--retry` or `-r` | N/A | No | Number of retries for failed GitLab API requests (default: 3) |
 
 ## Example
 

go.mod

@@ -3,18 +3,18 @@ module gitlab-sync
 go 1.24.2
 
 require (
+	github.com/hashicorp/go-retryablehttp v0.7.7
 	github.com/spf13/cobra v1.9.1
-	gitlab.com/gitlab-org/api/client-go v0.126.0
+	gitlab.com/gitlab-org/api/client-go v0.128.0
+	go.uber.org/zap v1.27.0
 )
 
 require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
-	golang.org/x/oauth2 v0.25.0 // indirect
-	golang.org/x/time v0.10.0 // indirect
+	golang.org/x/oauth2 v0.30.0 // indirect
+	golang.org/x/time v0.11.0 // indirect
 )

internal/mirroring/helper_test.go

@@ -292,6 +292,9 @@ func setupTestServer(t *testing.T, role string, instanceSize string) (*http.Serv
 	setupTestProjects(mux)
 	setupTestGroups(mux)
 
+	// Add test handlers for the GraphQL endpoint.
+	setupTestGraphQL(mux)
+
 	// Catch-all handler for undefined routes
 	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
 		http.Error(w, fmt.Sprintf("Undefined route accessed: %s %s", r.Method, r.URL.Path), http.StatusNotFound)
@@ -369,6 +372,29 @@ func setupTestGroup(mux *http.ServeMux, group *gitlab.Group, stringResponse stri
 	})
 }
 
+func setupTestGraphQL(mux *http.ServeMux) {
+	// Setup the GraphQL endpoint to return a mock response.
+	mux.HandleFunc("/api/graphql", func(w http.ResponseWriter, r *http.Request) {
+		switch r.Method {
+		case http.MethodPost:
+			w.Header().Set(HEADER_CONTENT_TYPE, HEADER_ACCEPT)
+			// Set response status to 200 OK
+			w.WriteHeader(http.StatusOK)
+			fmt.Fprint(w, `{
+				"data": {
+					"catalogResourcesCreate": {
+					"errors": []
+					}
+				},
+				"correlationId": "4a5a7b18e94ae6770b3933913989ef40"
+				}`)
+		default:
+			// Set response status to 405 Method Not Allowed
+			w.WriteHeader(http.StatusMethodNotAllowed)
+		}
+	})
+}
+
 // setupTestProjects sets up the test HTTP server with handlers for project-related
 func setupTestProjects(mux *http.ServeMux) {
 	// Setup the get projects endpoint to return a list of projects.

internal/mirroring/instance.go

@@ -3,8 +3,6 @@ package mirroring
 import (
 	"sync"
 
-	"gitlab-sync/internal/utils"
-
 	"github.com/hashicorp/go-retryablehttp"
 	gitlab "gitlab.com/gitlab-org/api/client-go"
 )
@@ -24,10 +22,6 @@ type GitlabInstance struct {
 	// muGroups is a mutex used to synchronize access to the Groups map
 	// It ensures that only one goroutine can read or write to the Groups map at a time
 	muGroups sync.RWMutex
-	// GraphQLClient is the GraphQL client used to interact with the GitLab GraphQL API
-	// It is used to perform GraphQL queries and mutations
-	// It is initialized with the GitLab token and URL
-	GraphQLClient *utils.GraphQLClient
 	// Role is the role of the GitLab instance, it can be either "source" or "destination"
 	// It is used to determine the behavior of the mirroring process
 	Role string
@@ -60,12 +54,11 @@ func newGitlabInstance(initArgs *GitlabInstanceOpts) (*GitlabInstance, error) {
 	}
 
 	gitlabInstance := &GitlabInstance{
-		Gitlab:        gitlabClient,
-		Projects:      make(map[string]*gitlab.Project),
-		Groups:        make(map[string]*gitlab.Group),
-		GraphQLClient: utils.NewGitlabGraphQLClient(initArgs.GitlabToken, initArgs.GitlabURL),
-		Role:          initArgs.Role,
-		InstanceSize:  initArgs.InstanceSize,
+		Gitlab:       gitlabClient,
+		Projects:     make(map[string]*gitlab.Project),
+		Groups:       make(map[string]*gitlab.Group),
+		Role:         initArgs.Role,
+		InstanceSize: initArgs.InstanceSize,
 	}
 
 	return gitlabInstance, nil

internal/mirroring/instance_test.go

@@ -32,10 +32,6 @@ func TestNewGitlabInstance(t *testing.T) {
 	if instance.Groups == nil {
 		t.Error("expected Groups map to be initialized")
 	}
-
-	if instance.GraphQLClient == nil {
-		t.Error("expected GraphQLClient to be initialized")
-	}
 }
 
 func TestAddProject(t *testing.T) {

internal/mirroring/post.go

@@ -1,6 +1,7 @@
 package mirroring
 
 import (
+	"context"
 	"fmt"
 	"sync"
 
@@ -277,3 +278,26 @@ func (destinationGitlab *GitlabInstance) mirrorReleases(sourceGitlab *GitlabInst
 	zap.L().Info("Releases mirroring completed", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
 	return utils.MergeErrors(errorChan, 2)
 }
+
+// addProjectToCICDCatalog adds a project to the CI/CD catalog in the destination GitLab instance.
+// It uses a GraphQL mutation to create the catalog resource for the project.
+func (g *GitlabInstance) addProjectToCICDCatalog(project *gitlab.Project) error {
+	zap.L().Debug("Adding project to CI/CD catalog", zap.String("project", project.HTTPURLToRepo))
+	mutation := `
+    mutation {
+        catalogResourcesCreate(input: { projectPath: "%s" }) {
+            errors
+        }
+    }`
+	query := fmt.Sprintf(mutation, project.PathWithNamespace)
+	var response struct {
+		Data struct {
+			CatalogResourcesCreate struct {
+				Errors []string `json:"errors"`
+			} `json:"catalogResourcesCreate"`
+		} `json:"data"`
+	}
+
+	_, err := g.Gitlab.GraphQL.Do(context.Background(), gitlab.GraphQLQuery{Query: query}, &response)
+	return err
+}

internal/mirroring/post_test.go

@@ -219,3 +219,13 @@ func TestCreateProjects(t *testing.T) {
 		}
 	})
 }
+
+func TestAddProjectToCICDCatalog(t *testing.T) {
+	_, gitlabInstance := setupTestServer(t, ROLE_DESTINATION, INSTANCE_SIZE_SMALL)
+	t.Run("Add Project to CI/CD Catalog", func(t *testing.T) {
+		err := gitlabInstance.addProjectToCICDCatalog(TEST_PROJECT)
+		if err != nil {
+			t.Errorf("Unexpected error when adding project to CI/CD catalog: %v", err)
+		}
+	})
+}

internal/mirroring/put.go

@@ -25,25 +25,6 @@ func (g *GitlabInstance) enableProjectMirrorPull(sourceProject *gitlab.Project,
 	return err
 }
 
-// addProjectToCICDCatalog adds a project to the CI/CD catalog in the destination GitLab instance.
-// It uses a GraphQL mutation to create the catalog resource for the project.
-//
-// NOTE: This function needs to be changed as soon as the gitlab SDK supports the GraphQL API.
-func (g *GitlabInstance) addProjectToCICDCatalog(project *gitlab.Project) error {
-	zap.L().Debug("Adding project to CI/CD catalog", zap.String("project", project.HTTPURLToRepo))
-	mutation := `
-    mutation {
-        catalogResourcesCreate(input: { projectPath: "%s" }) {
-            errors
-        }
-    }`
-	query := fmt.Sprintf(mutation, project.PathWithNamespace)
-	_, err := g.GraphQLClient.SendRequest(&utils.GraphQLRequest{
-		Query: query,
-	}, "POST")
-	return err
-}
-
 // copyProjectAvatar copies the avatar from the source project to the destination project.
 // It first checks if the destination project already has an avatar set. If not, it downloads the avatar from the source project
 // and uploads it to the destination project.

internal/utils/types.go

@@ -4,12 +4,9 @@ Utility types definitions
 package utils
 
 import (
-	"bytes"
-	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
-	"net/http"
 	"os"
 	"path/filepath"
 	"strings"
@@ -237,58 +234,3 @@ func checkVisibility(visibility string) bool {
 	}
 	return valid
 }
-
-// GraphQLClient is a client for sending GraphQL requests to GitLab
-type GraphQLClient struct {
-	token string
-	URL   string
-}
-
-// GraphQLRequest is a struct that represents a GraphQL request
-// It contains the query and the variables
-type GraphQLRequest struct {
-	Query     string `json:"query"`
-	Variables string `json:"variables,omitempty"`
-}
-
-// NewGitlabGraphQLClient creates a new GraphQL client for GitLab
-// It takes the token and the GitLab URL as arguments
-// It returns a pointer to the GraphQLClient struct
-func NewGitlabGraphQLClient(token, gitlabUrl string) *GraphQLClient {
-	return &GraphQLClient{
-		token: token,
-		URL:   strings.TrimSuffix(gitlabUrl, "/") + "/api/graphql",
-	}
-}
-
-// SendRequest sends a GraphQL request to GitLab
-// It takes a GraphQLRequest struct and the HTTP method as arguments
-// It returns the response body as a string and an error if any
-func (g *GraphQLClient) SendRequest(request *GraphQLRequest, method string) (string, error) {
-	requestBody, err := json.Marshal(request)
-	if err != nil {
-		return "", err
-	}
-	req, err := http.NewRequestWithContext(context.Background(), method, g.URL, bytes.NewBuffer(requestBody))
-	if err != nil {
-		return "", err
-	}
-
-	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("Authorization", "Bearer "+g.token)
-
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return "", err
-	}
-	defer resp.Body.Close()
-	if resp.StatusCode != http.StatusOK {
-		return "", fmt.Errorf("GraphQL request failed with status: %s", resp.Status)
-	}
-	var responseBody bytes.Buffer
-	if _, err := responseBody.ReadFrom(resp.Body); err != nil {
-		return "", err
-	}
-	return responseBody.String(), nil
-}

internal/utils/types_test.go

@@ -2,8 +2,6 @@ package utils
 
 import (
 	"fmt"
-	"net/http"
-	"net/http/httptest"
 	"os"
 	"reflect"
 	"testing"
@@ -228,35 +226,3 @@ func TestCheck(t *testing.T) {
 		})
 	}
 }
-
-// TestSendRequest tests sending a GraphQL request to GitLab
-func TestSendRequest(t *testing.T) {
-	client := NewGitlabGraphQLClient("test-token", "http://example.com")
-
-	request := &GraphQLRequest{
-		Query:     "query { test }",
-		Variables: "",
-	}
-
-	server := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		w.WriteHeader(http.StatusOK)
-		_, err := w.Write([]byte(`{"data": "response"}`))
-		if err != nil {
-			t.Fatalf("failed to write response: %v", err)
-		}
-	})
-	testServer := httptest.NewServer(server)
-	defer testServer.Close()
-
-	client.URL = testServer.URL
-
-	response, err := client.SendRequest(request, http.MethodPost)
-	if err != nil {
-		t.Fatalf("SendRequest() error = %v", err)
-	}
-
-	expectedResponse := `{"data": "response"}`
-	if response != expectedResponse {
-		t.Errorf("expected response %v, got %v", expectedResponse, response)
-	}
-}