go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/analysis/internal/clustering/algorithms/testname/testname_test.go

// Copyright 2022 The LUCI 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 testname

import (
	"testing"

	"go.chromium.org/luci/analysis/internal/clustering"
	"go.chromium.org/luci/analysis/internal/clustering/rules/lang"
	"go.chromium.org/luci/analysis/internal/config/compiledcfg"
	configpb "go.chromium.org/luci/analysis/proto/config"
	pb "go.chromium.org/luci/analysis/proto/v1"

	. "github.com/smartystreets/goconvey/convey"
)

func TestAlgorithm(t *testing.T) {
	rules := []*configpb.TestNameClusteringRule{
		{
			Name:         "Blink Web Tests",
			Pattern:      `^ninja://:blink_web_tests/(virtual/[^/]+/)?(?P<testname>([^/]+/)+[^/]+\.[a-zA-Z]+).*$`,
			LikeTemplate: "ninja://:blink\\_web\\_tests/%${testname}%",
		},
	}
	cfgpb := &configpb.ProjectConfig{
		Clustering: &configpb.Clustering{
			TestNameRules: rules,
		},
	}

	Convey(`Name`, t, func() {
		// Algorithm name should be valid.
		a := &Algorithm{}
		So(clustering.AlgorithmRe.MatchString(a.Name()), ShouldBeTrue)
	})
	Convey(`Cluster`, t, func() {
		a := &Algorithm{}
		cfg, err := compiledcfg.NewConfig(cfgpb)
		So(err, ShouldBeNil)

		Convey(`ID of appropriate length`, func() {
			id := a.Cluster(cfg, &clustering.Failure{
				TestID: "ninja://test_name",
			})
			// IDs may be 16 bytes at most.
			So(len(id), ShouldBeGreaterThan, 0)
			So(len(id), ShouldBeLessThanOrEqualTo, clustering.MaxClusterIDBytes)
		})
		Convey(`Same ID for same test name`, func() {
			Convey(`No matching rules`, func() {
				id1 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://test_name_one/",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "A"},
				})
				id2 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://test_name_one/",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "B"},
				})
				So(id2, ShouldResemble, id1)
			})
			Convey(`Matching rules`, func() {
				id1 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://:blink_web_tests/virtual/abc/folder/test-name.html",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "A"},
				})
				id2 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://:blink_web_tests/folder/test-name.html?param=2",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "B"},
				})
				So(id2, ShouldResemble, id1)
			})
		})
		Convey(`Different ID for different clusters`, func() {
			Convey(`No matching rules`, func() {
				id1 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://test_name_one/",
				})
				id2 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://test_name_two/",
				})
				So(id2, ShouldNotResemble, id1)
			})
			Convey(`Matching rules`, func() {
				id1 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://:blink_web_tests/virtual/abc/folder/test-name-a.html",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "A"},
				})
				id2 := a.Cluster(cfg, &clustering.Failure{
					TestID: "ninja://:blink_web_tests/folder/test-name-b.html?param=2",
					Reason: &pb.FailureReason{PrimaryErrorMessage: "B"},
				})
				So(id2, ShouldNotResemble, id1)
			})
		})
	})
	Convey(`Failure Association Rule`, t, func() {
		a := &Algorithm{}
		cfg, err := compiledcfg.NewConfig(cfgpb)
		So(err, ShouldBeNil)

		test := func(failure *clustering.Failure, expectedRule string) {
			rule := a.FailureAssociationRule(cfg, failure)
			So(rule, ShouldEqual, expectedRule)

			// Test the rule is valid syntax and matches at least the example failure.
			expr, err := lang.Parse(rule)
			So(err, ShouldBeNil)
			So(expr.Evaluate(failure), ShouldBeTrue)
		}
		Convey(`No matching rules`, func() {
			failure := &clustering.Failure{
				TestID: "ninja://test_name_one/",
			}
			test(failure, `test = "ninja://test_name_one/"`)
		})
		Convey(`Matching rule`, func() {
			failure := &clustering.Failure{
				TestID: "ninja://:blink_web_tests/virtual/dark-color-scheme/fast/forms/color-scheme/select/select-multiple-hover-unselected.html",
			}
			test(failure, `test LIKE "ninja://:blink\\_web\\_tests/%fast/forms/color-scheme/select/select-multiple-hover-unselected.html%"`)
		})
		Convey(`Escapes LIKE syntax`, func() {
			failure := &clustering.Failure{
				TestID: `ninja://:blink_web_tests/a/b_\%c.html`,
			}
			test(failure, `test LIKE "ninja://:blink\\_web\\_tests/%a/b\\_\\\\\\%c.html%"`)
		})
		Convey(`Escapes non-graphic Unicode characters`, func() {
			failure := &clustering.Failure{
				TestID: "\u0000\r\n\v\u202E\u2066",
			}
			test(failure, `test = "\x00\r\n\v\u202e\u2066"`)
		})
	})
	Convey(`Cluster Title`, t, func() {
		a := &Algorithm{}
		cfg, err := compiledcfg.NewConfig(cfgpb)
		So(err, ShouldBeNil)

		Convey(`No matching rules`, func() {
			failure := &clustering.Failure{
				TestID: "ninja://test_name_one",
			}
			title := a.ClusterTitle(cfg, failure)
			So(title, ShouldEqual, "ninja://test_name_one")
		})
		Convey(`Matching rule`, func() {
			failure := &clustering.Failure{
				TestID: "ninja://:blink_web_tests/virtual/dark-color-scheme/fast/forms/color-scheme/select/select-multiple-hover-unselected.html",
			}
			title := a.ClusterTitle(cfg, failure)
			So(title, ShouldEqual, `ninja://:blink\\_web\\_tests/%fast/forms/color-scheme/select/select-multiple-hover-unselected.html%`)
		})
	})
	Convey(`Cluster Description`, t, func() {
		a := &Algorithm{}
		cfg, err := compiledcfg.NewConfig(cfgpb)
		So(err, ShouldBeNil)

		Convey(`No matching rules`, func() {
			summary := &clustering.ClusterSummary{
				Example: clustering.Failure{
					TestID: "ninja://test_name_one",
				},
			}
			description, err := a.ClusterDescription(cfg, summary)
			So(err, ShouldBeNil)
			So(description.Title, ShouldEqual, "ninja://test_name_one")
			So(description.Description, ShouldContainSubstring, "ninja://test_name_one")
		})
		Convey(`Matching rule`, func() {
			summary := &clustering.ClusterSummary{
				Example: clustering.Failure{
					TestID: "ninja://:blink_web_tests/virtual/dark-color-scheme/fast/forms/color-scheme/select/select-multiple-hover-unselected.html",
				},
			}
			description, err := a.ClusterDescription(cfg, summary)
			So(err, ShouldBeNil)
			So(description.Title, ShouldEqual, `ninja://:blink\\_web\\_tests/%fast/forms/color-scheme/select/select-multiple-hover-unselected.html%`)
			So(description.Description, ShouldContainSubstring, `ninja://:blink\\_web\\_tests/%fast/forms/color-scheme/select/select-multiple-hover-unselected.html%`)
		})
	})
}