feat: add license check for destination gitlab

The execution now fails gracefully if the license tier of destination gitlab is not at least premium (required for pull mirroring)

Author: BoxBoxJason

internal/mirroring/get.go

@@ -13,6 +13,8 @@ import (
 
 const (
 	INSTANCE_SEMVER_THRESHOLD = "17.6"
+	ULTIMATE_PLAN             = "ultimate"
+	PREMIUM_PLAN              = "premium"
 )
 
 // fetchAll retrieves all projects and groups from the GitLab instance
@@ -104,3 +106,18 @@ func (g *GitlabInstance) CheckVersion() error {
 	}
 	return nil
 }
+
+func (g *GitlabInstance) CheckLicense() error {
+	license, _, err := g.Gitlab.License.GetLicense()
+	if err != nil {
+		return fmt.Errorf("failed to get GitLab license: %w", err)
+	}
+	if license.Plan != ULTIMATE_PLAN && license.Plan != PREMIUM_PLAN {
+		return fmt.Errorf("GitLab license plan %s is not supported, only %s and %s are supported", license.Plan, ULTIMATE_PLAN, PREMIUM_PLAN)
+	} else if license.Expired {
+		return fmt.Errorf("GitLab license is expired")
+	}
+
+	zap.L().Debug("GitLab Instance license", zap.String(ROLE, g.Role), zap.String("plan", license.Plan))
+	return nil
+}

internal/mirroring/get_test.go

@@ -250,3 +250,58 @@ func TestCheckVersion(t *testing.T) {
 		})
 	}
 }
+
+func TestCheckLicense(t *testing.T) {
+	tests := []struct {
+		name          string
+		license       string
+		expectedError bool
+	}{
+		{
+			name:          "Ultimate tier license",
+			license:       "ultimate",
+			expectedError: false,
+		},
+		{
+			name:          "Premium tier license",
+			license:       "premium",
+			expectedError: false,
+		},
+		{
+			name:          "Free tier license",
+			license:       "free",
+			expectedError: true,
+		},
+		{
+			name:          "Invalid license",
+			license:       "invalid",
+			expectedError: true,
+		},
+		{
+			name:          "Empty license",
+			license:       "",
+			expectedError: true,
+		},
+	}
+	// Iterate over the test cases
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+
+			mux, gitlabInstance := setupEmptyTestServer(t, ROLE_DESTINATION, INSTANCE_SIZE_SMALL)
+			mux.HandleFunc("/api/v4/license", func(w http.ResponseWriter, r *http.Request) {
+				w.Header().Set("Content-Type", "application/json")
+				w.WriteHeader(http.StatusOK)
+				_, err := w.Write([]byte(`{"plan": "` + test.license + `"}`))
+				if err != nil {
+					t.Errorf("failed to write response: %v", err)
+				}
+			})
+
+			err := gitlabInstance.CheckLicense()
+			if (err != nil) != test.expectedError {
+				t.Errorf("expected error: %v, got: %v", test.expectedError, err)
+			}
+		})
+	}
+}

internal/mirroring/helper_test.go

@@ -554,24 +554,6 @@ func setupTestProject(mux *http.ServeMux, project *gitlab.Project, stringRespons
 	})
 }
 
-// setupMetadata sets up the test HTTP server with handlers for metadata-related actions.
-// This includes the version endpoint.
-func setupMetadata(mux *http.ServeMux) {
-	// Setup the version endpoint to return a mock response.
-	mux.HandleFunc("/api/v4/metadata", func(w http.ResponseWriter, r *http.Request) {
-		switch r.Method {
-		case http.MethodGet:
-			w.Header().Set(HEADER_CONTENT_TYPE, HEADER_ACCEPT)
-			// Set response status to 200 OK
-			w.WriteHeader(http.StatusOK)
-			fmt.Fprint(w, `{"version": "18.0.0"}`)
-		default:
-			// Set response status to 405 Method Not Allowed
-			w.WriteHeader(http.StatusMethodNotAllowed)
-		}
-	})
-}
-
 func TestReverseGroupMirrorMap(t *testing.T) {
 	tests := []struct {
 		name                     string

internal/mirroring/main.go

@@ -46,7 +46,7 @@ func MirrorGitlabs(gitlabMirrorArgs *utils.ParserArgs) []error {
 	if err != nil {
 		return []error{err}
 	}
-	err = destinationGitlabInstance.CheckVersion()
+	err = destinationGitlabInstance.CheckDestinationInstance()
 	if err != nil {
 		return []error{err}
 	}
@@ -143,3 +143,14 @@ func DryRun(sourceGitlabInstance *GitlabInstance, gitlabMirrorArgs *utils.Parser
 		}
 	}
 }
+
+func (destinationGitlab *GitlabInstance) CheckDestinationInstance() error {
+	zap.L().Info("Checking destination GitLab instance")
+	if err := destinationGitlab.CheckVersion(); err != nil {
+		return fmt.Errorf("destination GitLab instance version check failed: %w", err)
+	}
+	if err := destinationGitlab.CheckVersion(); err != nil {
+		return fmt.Errorf("destination GitLab instance version check failed: %w", err)
+	}
+	return nil
+}