go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/buildbucket/protoutil/builder_test.go

// Copyright 2019 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 protoutil

import (
	"testing"

	pb "go.chromium.org/luci/buildbucket/proto"

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

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

	Convey("ValidateBuilderID", t, func() {
		Convey("nil", func() {
			err := ValidateBuilderID(nil)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("empty", func() {
			b := &pb.BuilderID{}
			err := ValidateBuilderID(b)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("project", func() {
			b := &pb.BuilderID{}
			err := ValidateBuilderID(b)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("bucket", func() {
			Convey("empty", func() {
				b := &pb.BuilderID{
					Project: "project",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldBeNil)
			})

			Convey("invalid", func() {
				b := &pb.BuilderID{
					Project: "project",
					Bucket:  "bucket!",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldErrLike, "bucket must match")
			})

			Convey("v1", func() {
				b := &pb.BuilderID{
					Project: "project",
					Bucket:  "luci.project.bucket",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldErrLike, "invalid use of v1 bucket in v2 API")
			})

			Convey("ok", func() {
				b := &pb.BuilderID{
					Project: "project",
					Bucket:  "bucket",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldBeNil)
			})
		})

		Convey("builder", func() {
			Convey("empty", func() {
				b := &pb.BuilderID{
					Project: "project",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldBeNil)
			})

			Convey("invalid", func() {
				b := &pb.BuilderID{
					Project: "project",
					Builder: "builder!",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldErrLike, "builder must match")
			})

			Convey("ok", func() {
				b := &pb.BuilderID{
					Project: "project",
					Builder: "builder",
				}
				err := ValidateBuilderID(b)
				So(err, ShouldBeNil)
			})
		})
	})
}

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

	Convey("ValidateRequiredBuilderID", t, func() {
		Convey("nil", func() {
			err := ValidateRequiredBuilderID(nil)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("empty", func() {
			b := &pb.BuilderID{}
			err := ValidateRequiredBuilderID(b)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("project", func() {
			b := &pb.BuilderID{}
			err := ValidateRequiredBuilderID(b)
			So(err, ShouldErrLike, "project must match")
		})

		Convey("bucket", func() {
			Convey("empty", func() {
				b := &pb.BuilderID{
					Project: "project",
				}
				err := ValidateRequiredBuilderID(b)
				So(err, ShouldErrLike, "bucket is required")
			})

			Convey("invalid", func() {
				b := &pb.BuilderID{
					Project: "project",
					Bucket:  "bucket!",
				}
				err := ValidateRequiredBuilderID(b)
				So(err, ShouldErrLike, "bucket must match")
			})

			Convey("v1", func() {
				b := &pb.BuilderID{
					Project: "project",
					Bucket:  "luci.project.bucket",
				}
				err := ValidateRequiredBuilderID(b)
				So(err, ShouldErrLike, "invalid use of v1 bucket in v2 API")
			})

			Convey("builder", func() {
				Convey("empty", func() {
					b := &pb.BuilderID{
						Project: "project",
						Bucket:  "bucket",
					}
					err := ValidateRequiredBuilderID(b)
					So(err, ShouldErrLike, "builder is required")
				})

				Convey("invalid", func() {
					b := &pb.BuilderID{
						Project: "project",
						Bucket:  "bucket",
						Builder: "builder!",
					}
					err := ValidateRequiredBuilderID(b)
					So(err, ShouldErrLike, "builder must match")
				})

				Convey("ok", func() {
					b := &pb.BuilderID{
						Project: "project",
						Bucket:  "bucket",
						Builder: "builder",
					}
					err := ValidateRequiredBuilderID(b)
					So(err, ShouldBeNil)
				})
			})
		})
	})
}

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

	Convey("FormatBuilderID", t, func() {
		So(FormatBuilderID(&pb.BuilderID{
			Project: "proj",
			Bucket:  "bucket",
			Builder: "builder",
		}),
			ShouldEqual,
			"proj/bucket/builder")
	})

	Convey("FormatBucketID", t, func() {
		So(FormatBucketID("proj", "bucket"), ShouldEqual, "proj/bucket")
	})

	Convey("ParseBucketID", t, func() {
		Convey("valid", func() {
			p, b, err := ParseBucketID("proj/bucket")
			So(err, ShouldBeNil)
			So(p, ShouldEqual, "proj")
			So(b, ShouldEqual, "bucket")
		})

		Convey("invalid", func() {
			_, _, err := ParseBucketID("proj/bucket/bldr")
			So(err, ShouldErrLike, "invalid bucket id; must have 1 slash")

			_, _, err = ParseBucketID(" / ")
			So(err, ShouldErrLike, "invalid bucket id; project is empty")

			_, _, err = ParseBucketID("proj/ ")
			So(err, ShouldErrLike, "invalid bucket id; bucket is empty")
		})
	})
}