Merge "Check for duplicated zuul connection"

Author: Microzuul CI

controllers/softwarefactory_controller.go

@@ -191,6 +191,32 @@ func resolveConfigBaseURL(cr sfv1.SoftwareFactory) string {
 	return ""
 }
 
+func GetUserDefinedConnections(cr *sfv1.SoftwareFactory) []string {
+	var conns []string
+	for _, conn := range cr.Spec.Zuul.GerritConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.GitHubConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.GitLabConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.GitConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.PagureConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.ElasticSearchConns {
+		conns = append(conns, conn.Name)
+	}
+	for _, conn := range cr.Spec.Zuul.SMTPConns {
+		conns = append(conns, conn.Name)
+	}
+	return conns
+}
+
 func (r *SFController) IsCodesearchEnabled() bool {
 	return r.cr.Spec.Codesearch.Enabled == nil || *r.cr.Spec.Codesearch.Enabled
 }
@@ -406,9 +432,27 @@ func CheckOpenShift() bool {
 	return openshiftUser
 }
 
+func HasDuplicate(conns []string) string {
+	for i, conn := range conns {
+		if slices.Contains(conns[i+1:], conn) {
+			return conn
+		}
+	}
+	return ""
+}
+
 func (r *SoftwareFactoryReconciler) mkSFController(
 	ctx context.Context, ns string, owner client.Object, cr sfv1.SoftwareFactory,
 	standalone bool) SFController {
+	conns := GetUserDefinedConnections(&cr)
+	if dup := HasDuplicate(conns); dup != "" {
+		fmt.Fprintf(os.Stderr, "Duplicate zuul connection: %s", dup)
+		os.Exit(1)
+	}
+	if slices.Contains(conns, "git-server") {
+		fmt.Fprintf(os.Stderr, "The git-server connection name is reserved, please rename it")
+		os.Exit(1)
+	}
 	return SFController{
 		SFUtilContext: SFUtilContext{
 			Client:     r.Client,

controllers/suite_test.go

@@ -46,6 +46,26 @@ func TestAPIs(t *testing.T) {
 	RunSpecs(t, "Controller Suite")
 }
 
+func TestDuplicateConn(t *testing.T) {
+	var cr sfv1.SoftwareFactory
+	if HasDuplicate(GetUserDefinedConnections(&cr)) != "" {
+		t.Errorf("CR does not have dup")
+	}
+	cr.Spec.Zuul.GitConns = []sfv1.GitConnection{
+		sfv1.GitConnection{
+			Name: "opendev.org",
+		},
+	}
+	cr.Spec.Zuul.GerritConns = []sfv1.GerritConnection{
+		sfv1.GerritConnection{
+			Name: "opendev.org",
+		},
+	}
+	if HasDuplicate(GetUserDefinedConnections(&cr)) != "opendev.org" {
+		t.Errorf("CR have dup")
+	}
+}
+
 var _ = BeforeSuite(func() {
 	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 

doc/reference/CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 ## [in development]
 
 ### Added
+
+- zuul: the operator now validates that the user provided connections doesn't have any duplicate names.
+
 ### Changed
 
 - logjuicer service is based on a ubi9 base image