test: add unit tests for conflicting markers analyzer and custom configurations

Author: yongruilin

pkg/analysis/conflictingmarkers/analyzer_test.go

@@ -0,0 +1,51 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package conflictingmarkers_test
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/conflictingmarkers"
+)
+
+func TestConflictingMarkersAnalyzer(t *testing.T) {
+	testdata := analysistest.TestData()
+
+	config := &conflictingmarkers.ConflictingMarkersConfig{
+		Conflicts: []conflictingmarkers.ConflictSet{
+			{
+				Name:        "test_conflict",
+				Sets:        [][]string{{"marker1", "marker2"}, {"marker3", "marker4"}},
+				Description: "Test markers conflict with each other",
+			},
+			{
+				Name:        "three_way_conflict",
+				Sets:        [][]string{{"marker5", "marker6"}, {"marker7", "marker8"}, {"marker9", "marker10"}},
+				Description: "Three-way conflict between marker sets",
+			},
+		},
+	}
+
+	initializer := conflictingmarkers.Initializer()
+
+	analyzer, err := initializer.Init(config)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	analysistest.Run(t, testdata, analyzer, "a")
+}

pkg/analysis/conflictingmarkers/testdata/src/a/a.go

@@ -0,0 +1,60 @@
+package a
+
+type TestStruct struct {
+	// Valid field with only marker1
+	// +marker1
+	ValidMarker1Field string `json:"validMarker1Field"`
+
+	// Valid field with marker1 that has a value
+	// +marker1:=someValue
+	ValidMarker1WithValueField string `json:"validMarker1WithValueField"`
+
+	// Valid field with marker1 and marker2 (both in same conflict set)
+	// +marker1
+	// +marker2
+	ValidMarker1And2Field string `json:"validMarker1And2Field"`
+
+	// Conflict: marker1 vs marker3 (both with values)
+	// +marker1:=value1
+	// +marker3:=value2
+	ConflictWithValuesField string `json:"conflictWithValuesField"` // want "field ConflictWithValuesField has conflicting markers: test_conflict: \\{\\[marker1\\], \\[marker3\\]\\}. Test markers conflict with each other"
+
+	// Conflict: marker1 vs marker3 (mixed with and without values)
+	// +marker1
+	// +marker3:=someValue
+	ConflictMixedField string `json:"conflictMixedField"` // want "field ConflictMixedField has conflicting markers: test_conflict: \\{\\[marker1\\], \\[marker3\\]\\}. Test markers conflict with each other"
+
+	// Multiple conflicts with multiple markers in each set:
+	// +marker1
+	// +marker2
+	// +marker3
+	// +marker4
+	MultipleConflictsField string `json:"multipleConflictsField"` // want "field MultipleConflictsField has conflicting markers: test_conflict: \\{\\[marker1 marker2\\], \\[marker3 marker4\\]\\}. Test markers conflict with each other"
+
+	// Three-way conflict: marker5 vs marker7 vs marker9
+	// +marker5
+	// +marker7
+	// +marker9
+	ThreeWayConflictField string `json:"threeWayConflictField"` // want "field ThreeWayConflictField has conflicting markers: three_way_conflict: \\{\\[marker5\\], \\[marker7\\], \\[marker9\\]\\}. Three-way conflict between marker sets"
+
+	// Three-way conflict with values
+	// +marker6:=value1
+	// +marker8:=value2
+	// +marker10:=value3
+	ThreeWayConflictWithValuesField string `json:"threeWayConflictWithValuesField"` // want "field ThreeWayConflictWithValuesField has conflicting markers: three_way_conflict: \\{\\[marker6\\], \\[marker8\\], \\[marker10\\]\\}. Three-way conflict between marker sets"
+
+	// Valid field with markers from same set in three-way conflict
+	// +marker5
+	// +marker6
+	ValidThreeWaySameSetField string `json:"validThreeWaySameSetField"`
+
+	// Three-way conflict with multiple markers from each set
+	// +marker5
+	// +marker6
+	// +marker7
+	// +marker8
+	// +marker9
+	// +marker10
+	ThreeWayMultipleMarkersField string `json:"threeWayMultipleMarkersField"` // want "field ThreeWayMultipleMarkersField has conflicting markers: three_way_conflict: \\{\\[marker5 marker6\\], \\[marker7 marker8\\], \\[marker10 marker9\\]\\}. Three-way conflict between marker sets"
+
+}