feat: add full project resync

added a function to check if a project data does not match and update it if needed
created unit tests for all new functions added

Author: BoxBoxJason

internal/mirroring/post.go

@@ -226,7 +226,7 @@ func (g *GitlabInstance) createProjectFromSource(sourceProject *gitlab.Project,
 // The function handles the API calls concurrently using goroutines and a wait group.
 // It returns an error if any of the API calls fail.
 func (destinationGitlab *GitlabInstance) mirrorReleases(sourceGitlab *GitlabInstance, sourceProject *gitlab.Project, destinationProject *gitlab.Project) []error {
-	zap.L().Debug("Starting releases mirroring", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
+	zap.L().Info("Starting releases mirroring", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
 	// Fetch existing releases from the destination project
 	existingReleases, _, err := destinationGitlab.Gitlab.Releases.ListReleases(destinationProject.ID, &gitlab.ListReleasesOptions{})
 	if err != nil {

internal/mirroring/put.go

@@ -94,7 +94,7 @@ func (sourceGitlabInstance *GitlabInstance) copyGroupAvatar(destinationGitlabIns
 // The function uses goroutines to perform these tasks concurrently and waits for all of them to finish.
 func (destinationGitlabInstance *GitlabInstance) updateProjectFromSource(sourceGitlabInstance *GitlabInstance, sourceProject *gitlab.Project, destinationProject *gitlab.Project, copyOptions *utils.MirroringOptions) []error {
 	wg := sync.WaitGroup{}
-	maxErrors := 2
+	maxErrors := 3
 	if copyOptions.CI_CD_Catalog {
 		maxErrors++
 	}
@@ -106,44 +106,92 @@ func (destinationGitlabInstance *GitlabInstance) updateProjectFromSource(sourceG
 
 	go func() {
 		defer wg.Done()
+		errorChan <- destinationGitlabInstance.syncProjectAttributes(sourceProject, destinationProject, copyOptions)
+	}()
 
-		zap.L().Debug("Enabling project mirror pull", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
-		err := destinationGitlabInstance.enableProjectMirrorPull(sourceProject, destinationProject, copyOptions)
-		if err != nil {
-			errorChan <- fmt.Errorf("failed to enable project mirror pull for %s: %s", destinationProject.HTTPURLToRepo, err)
-		}
+	go func() {
+		defer wg.Done()
+		errorChan <- destinationGitlabInstance.enableProjectMirrorPull(sourceProject, destinationProject, copyOptions)
 	}()
 
 	go func() {
 		defer wg.Done()
-		zap.L().Debug("Copying project avatar", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
-		err := sourceGitlabInstance.copyProjectAvatar(destinationGitlabInstance, destinationProject, sourceProject)
-		if err != nil {
-			errorChan <- fmt.Errorf("failed to copy project avatar for %s: %s", destinationProject.HTTPURLToRepo, err)
-		}
+		errorChan <- sourceGitlabInstance.copyProjectAvatar(destinationGitlabInstance, destinationProject, sourceProject)
 	}()
 
 	if copyOptions.CI_CD_Catalog {
 		go func() {
 			defer wg.Done()
-			err := destinationGitlabInstance.addProjectToCICDCatalog(destinationProject)
-			if err != nil {
-				errorChan <- fmt.Errorf("failed to add project %s to CI/CD catalog: %s", destinationProject.HTTPURLToRepo, err)
-			}
+			errorChan <- destinationGitlabInstance.addProjectToCICDCatalog(destinationProject)
 		}()
 	}
 
+	allErrors := []error{}
 	if copyOptions.MirrorReleases {
 		go func() {
 			defer wg.Done()
-			err := destinationGitlabInstance.mirrorReleases(sourceGitlabInstance, sourceProject, destinationProject)
-			if err != nil {
-				errorChan <- fmt.Errorf("failed to copy project %s releases: %s", destinationProject.HTTPURLToRepo, err)
-			}
+			allErrors = destinationGitlabInstance.mirrorReleases(sourceGitlabInstance, sourceProject, destinationProject)
 		}()
 	}
 
 	wg.Wait()
 	close(errorChan)
-	return utils.MergeErrors(errorChan)
+	for err := range errorChan {
+		if err != nil {
+			allErrors = append(allErrors, err)
+		}
+	}
+	return allErrors
+}
+
+// syncProjectAttributes updates the destination project with settings from the source project.
+// It checks if any diverged project data exists and if so, it overwrites it.
+func (destinationGitlabInstance *GitlabInstance) syncProjectAttributes(sourceProject *gitlab.Project, destinationProject *gitlab.Project, copyOptions *utils.MirroringOptions) error {
+	zap.L().Debug("Checking if project requires attributes resync", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
+	gitlabEditOptions := &gitlab.EditProjectOptions{}
+	missmatched := false
+	if sourceProject.Name != destinationProject.Name {
+		gitlabEditOptions.Name = &sourceProject.Name
+		missmatched = true
+	}
+	if sourceProject.Description != destinationProject.Description {
+		gitlabEditOptions.Description = &sourceProject.Description
+		missmatched = true
+	}
+	if sourceProject.DefaultBranch != destinationProject.DefaultBranch {
+		gitlabEditOptions.DefaultBranch = &sourceProject.DefaultBranch
+		missmatched = true
+	}
+	if !utils.StringArraysMatchValues(sourceProject.Topics, destinationProject.Topics) {
+		gitlabEditOptions.Topics = &sourceProject.Topics
+		missmatched = true
+	}
+	if copyOptions.MirrorTriggerBuilds != destinationProject.MirrorTriggerBuilds {
+		gitlabEditOptions.MirrorTriggerBuilds = &copyOptions.MirrorTriggerBuilds
+		missmatched = true
+	}
+	if !destinationProject.MirrorOverwritesDivergedBranches {
+		gitlabEditOptions.MirrorOverwritesDivergedBranches = gitlab.Ptr(true)
+		missmatched = true
+	}
+	if !destinationProject.Mirror {
+		gitlabEditOptions.Mirror = gitlab.Ptr(true)
+		missmatched = true
+	}
+	if copyOptions.Visibility != string(destinationProject.Visibility) {
+		visibilityValue := utils.ConvertVisibility(copyOptions.Visibility)
+		gitlabEditOptions.Visibility = &visibilityValue
+		missmatched = true
+	}
+
+	if missmatched {
+		destinationProject, _, err := destinationGitlabInstance.Gitlab.Projects.EditProject(destinationProject.ID, gitlabEditOptions)
+		if err != nil {
+			return fmt.Errorf("failed to edit project %s: %s", destinationProject.HTTPURLToRepo, err)
+		}
+		zap.L().Debug("Project attributes resync completed", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
+	} else {
+		zap.L().Debug("Project attributes are already in sync, skipping", zap.String(ROLE_SOURCE, sourceProject.HTTPURLToRepo), zap.String(ROLE_DESTINATION, destinationProject.HTTPURLToRepo))
+	}
+	return nil
 }

internal/utils/types.go

@@ -160,7 +160,7 @@ func (m *MirrorMapping) checkProjects(errChan chan error) {
 		// Check the visibility
 		visibilityString := strings.TrimSpace(string(options.Visibility))
 		if visibilityString != "" && !checkVisibility(visibilityString) {
-			errChan <- fmt.Errorf("invalid project visibility: %s", string(options.Visibility))
+			errChan <- fmt.Errorf("invalid project visibility: %s", options.Visibility)
 			options.Visibility = string(gitlab.PublicVisibility)
 		}
 	}
@@ -225,3 +225,32 @@ func checkVisibility(visibility string) bool {
 	}
 	return valid
 }
+
+func ConvertVisibility(visibility string) gitlab.VisibilityValue {
+	switch visibility {
+	case string(gitlab.PublicVisibility):
+		return gitlab.PublicVisibility
+	case string(gitlab.InternalVisibility):
+		return gitlab.InternalVisibility
+	case string(gitlab.PrivateVisibility):
+		return gitlab.PrivateVisibility
+	default:
+		return gitlab.PublicVisibility
+	}
+}
+
+func StringArraysMatchValues(array1 []string, array2 []string) bool {
+	if len(array1) != len(array2) {
+		return false
+	}
+	matchMap := make(map[string]struct{}, len(array1))
+	for _, value := range array1 {
+		matchMap[value] = struct{}{}
+	}
+	for _, value := range array2 {
+		if _, ok := matchMap[value]; !ok {
+			return false
+		}
+	}
+	return true
+}