go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/cv/internal/configs/validation/service_test.go

// Copyright 2018 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 validation

import (
	"testing"

	"go.chromium.org/luci/config/validation"
	cfgpb "go.chromium.org/luci/cv/api/config/v2"
	"go.chromium.org/luci/cv/internal/configs/prjcfg"
	"go.chromium.org/luci/cv/internal/cvtesting"
	"go.chromium.org/luci/gae/service/datastore"

	. "github.com/smartystreets/goconvey/convey"
	. "go.chromium.org/luci/common/testing/assertions"
)

func TestListenerConfigValidation(t *testing.T) {
	t.Parallel()

	Convey("Validate Config", t, func() {
		ct := cvtesting.Test{}
		ctx, cancel := ct.SetUp(t)
		defer cancel()

		vctx := &validation.Context{Context: ctx}
		configSet := "services/luci-change-verifier"
		path := "listener-settings.cfg"

		Convey("Loading bad proto", func() {
			content := []byte(` bad: "config" `)
			So(validateListenerSettings(vctx, configSet, path, content), ShouldBeNil)
			So(vctx.Finalize().Error(), ShouldContainSubstring, "unknown field")
		})

		Convey("OK", func() {
			cfg := []byte(`
				gerrit_subscriptions {
					host: "chromium-review.googlesource.com"
					receive_settings: {
						num_goroutines: 100
						max_outstanding_messages: 5000
					}
					message_format: JSON
				}
				gerrit_subscriptions {
					host: "pigweed-review.googlesource.com"
					subscription_id: "pigweed_gerrit"
					receive_settings: {
						num_goroutines: 100
						max_outstanding_messages: 5000
					}
					message_format: PROTO_BINARY
				}
			`)
			Convey("fully loaded", func() {
				So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
				So(vctx.Finalize(), ShouldBeNil)
			})
			Convey("empty", func() {
				So(validateListenerSettings(vctx, configSet, path, []byte{}), ShouldBeNil)
				So(vctx.Finalize(), ShouldBeNil)
			})
		})

		Convey("Fail", func() {
			Convey("multiple subscriptions for the same host", func() {
				cfg := []byte(`
					gerrit_subscriptions {
						host: "example.org"
						subscription_id: "sub"
						message_format: JSON
					}
					gerrit_subscriptions {
						host: "example.org"
						subscription_id: "sub2"
						message_format: JSON
					}
				`)
				So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
				So(vctx.Finalize(), ShouldErrLike, `already exists for host "example.org"`)
			})

			Convey("invalid disabled_project_regexps", func() {
				cfg := []byte(`
					disabled_project_regexps: "(123"
				`)
				So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
				So(vctx.Finalize(), ShouldErrLike, "missing closing")
			})

			Convey("invalid message_format", func() {
				cfg := []byte(`
					gerrit_subscriptions {
						host: "example.org"
					}
				`)
				So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
				So(vctx.Finalize().Error(), ShouldContainSubstring,
					"message_format): must be specified")
			})
		})

		Convey("watched repo", func() {
			pc := &prjcfg.ProjectConfig{
				Project:          "chromium",
				ConfigGroupNames: []string{"main"},
				Hash:             "sha256:deadbeef",
				Enabled:          true,
			}
			cpb := &cfgpb.ConfigGroup{
				Name: "main",
				Gerrit: []*cfgpb.ConfigGroup_Gerrit{
					{
						Url: "https://chromium-review.googlesoure.com/foo",
						Projects: []*cfgpb.ConfigGroup_Gerrit_Project{
							{Name: "cr/src1"},
							{Name: "cr/src2"},
						},
					},
				},
			}
			cg := &prjcfg.ConfigGroup{
				Project: prjcfg.ProjectConfigKey(ctx, pc.Project),
				ID:      prjcfg.MakeConfigGroupID(pc.Hash, "main"),
				Content: cpb,
			}
			So(datastore.Put(ctx, pc, cg), ShouldBeNil)

			Convey("missing gerrit_subscriptions", func() {
				cfg := []byte(`
					gerrit_subscriptions {
						host: "pigweed-review.googlesource.com"
						subscription_id: "pigweed_gerrit"
						receive_settings: {
							num_goroutines: 100
							max_outstanding_messages: 5000
						}
						message_format: PROTO_BINARY
					}
				`)

				Convey("fails", func() {
					So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
					So(vctx.Finalize(), ShouldErrLike, "there is no gerrit_subscriptions")
				})

				Convey("succeeeds if disabled in listener settings", func() {
					cfg := append(cfg, []byte(`
						disabled_project_regexps: "chromium"
					`)...)
					So(validateListenerSettings(vctx, configSet, path, cfg), ShouldBeNil)
					So(vctx.Finalize(), ShouldBeNil)
				})
			})
		})
	})
}