go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/bisection/internal/gerrit/utils_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 gerrit

import (
	"context"
	"testing"
	"time"

	. "github.com/smartystreets/goconvey/convey"
	"google.golang.org/protobuf/types/known/timestamppb"

	"go.chromium.org/luci/common/clock"
	"go.chromium.org/luci/common/clock/testclock"
	gerritpb "go.chromium.org/luci/common/proto/gerrit"
	. "go.chromium.org/luci/common/testing/assertions"
	"go.chromium.org/luci/gae/impl/memory"
)

func TestGetHost(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	Convey("Empty string returns error", t, func() {
		host, err := GetHost(ctx, "")
		So(err, ShouldErrLike, "could not find Gerrit host")
		So(host, ShouldEqual, "")
	})

	Convey("Non-URL format returns error", t, func() {
		host, err := GetHost(ctx, "[Test] This is a review title, not a URL")
		So(err, ShouldErrLike, "could not find Gerrit host")
		So(host, ShouldEqual, "")
	})

	Convey("Gets host from review URL", t, func() {
		host, err := GetHost(ctx, " https://chromium-test-review.googlesource.com/c/proj/+/1200003\n")
		So(err, ShouldBeNil)
		So(host, ShouldEqual, "chromium-test-review.googlesource.com")
	})
}

func TestHasLUCIBisectionComment(t *testing.T) {
	t.Parallel()
	ctx := memory.Use(context.Background())

	Convey("No comments", t, func() {
		hasLBComment, err := HasLUCIBisectionComment(ctx, &gerritpb.ChangeInfo{})
		So(err, ShouldBeNil)
		So(hasLBComment, ShouldEqual, false)
	})

	Convey("No LUCI Bisection comment", t, func() {
		change := &gerritpb.ChangeInfo{
			Messages: []*gerritpb.ChangeMessageInfo{
				{
					Id:      "19283",
					Message: "Automated message from Gerrit with no author",
					Tag:     "autogenerated:gerrit:test",
				},
				{
					Id: "19284",
					Author: &gerritpb.AccountInfo{
						Name:      "John Doe",
						Email:     "jdoe@example.com",
						Username:  "jdoe",
						AccountId: 100001,
					},
				},
			},
		}
		hasLBComment, err := HasLUCIBisectionComment(ctx, change)
		So(err, ShouldBeNil)
		So(hasLBComment, ShouldEqual, false)
	})

	Convey("LUCI Bisection has commented", t, func() {
		// Get the service account email value in this test context
		testEmail, err := ServiceAccountEmail(ctx)
		So(err, ShouldBeNil)

		change := &gerritpb.ChangeInfo{
			Messages: []*gerritpb.ChangeMessageInfo{
				{
					Id:      "19285",
					Message: "Automated message from Gerrit with no author",
					Tag:     "autogenerated:gerrit:test",
				},
				{
					Id: "19286",
					Author: &gerritpb.AccountInfo{
						Name:      "LUCI Bisection",
						Email:     testEmail,
						Username:  "gae_service_account",
						AccountId: 900009,
					},
				},
				{
					Id: "19287",
					Author: &gerritpb.AccountInfo{
						Name:      "John Doe",
						Email:     "jdoe@example.com",
						Username:  "jdoe",
						AccountId: 100001,
					},
				},
			},
		}
		hasLBComment, err := HasLUCIBisectionComment(ctx, change)
		So(err, ShouldBeNil)
		So(hasLBComment, ShouldEqual, true)
	})
}

func TestIsOwnedByLUCIBisection(t *testing.T) {
	t.Parallel()
	ctx := memory.Use(context.Background())

	Convey("No owner", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  615243,
		}
		lbOwned, err := IsOwnedByLUCIBisection(ctx, change)
		So(err, ShouldBeNil)
		So(lbOwned, ShouldEqual, false)
	})

	Convey("Change is not owned by LUCI Bisection", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  615243,
			Owner: &gerritpb.AccountInfo{
				Name:      "John Doe",
				Email:     "jdoe@example.com",
				Username:  "jdoe",
				AccountId: 100001,
			},
		}
		lbOwned, err := IsOwnedByLUCIBisection(ctx, change)
		So(err, ShouldBeNil)
		So(lbOwned, ShouldEqual, false)
	})

	Convey("Change is owned by LUCI Bisection", t, func() {
		// Get the service account email value in this test context
		testEmail, err := ServiceAccountEmail(ctx)
		So(err, ShouldBeNil)

		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  615243,
			Owner: &gerritpb.AccountInfo{
				Name:      "LUCI Bisection",
				Email:     testEmail,
				Username:  "gae_service_account",
				AccountId: 900009,
			},
		}
		lbOwned, err := IsOwnedByLUCIBisection(ctx, change)
		So(err, ShouldBeNil)
		So(lbOwned, ShouldEqual, true)
	})
}

func TestIsRecentSubmit(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	// Set test clock
	cl := testclock.New(testclock.TestTimeUTC)
	ctx = clock.Set(ctx, cl)

	Convey("IsRecentSubmit", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  234567,
		}
		maxAge := time.Duration(6) * time.Hour

		Convey("change submitted now is recent", func() {
			change.Submitted = timestamppb.New(clock.Now(ctx))
			So(IsRecentSubmit(ctx, change, maxAge), ShouldEqual, true)
		})

		Convey("change submitted at threshold time is recent", func() {
			change.Submitted = timestamppb.New(clock.Now(ctx).Add(-time.Hour * 6))
			So(IsRecentSubmit(ctx, change, maxAge), ShouldEqual, true)
		})

		Convey("change submitted a while ago is not recent", func() {
			change.Submitted = timestamppb.New(clock.Now(ctx).Add(-time.Hour * 30))
			So(IsRecentSubmit(ctx, change, maxAge), ShouldEqual, false)
		})
	})
}

func TestHasAutoRevertOffFlagSet(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	Convey("change does not have enough information", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  234567,
		}
		_, err := HasAutoRevertOffFlagSet(ctx, change)
		So(err, ShouldErrLike, "could not get", "info")
	})

	Convey("change does not mention flag", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
					},
				},
			},
		}

		hasFlag, err := HasAutoRevertOffFlagSet(ctx, change)
		So(err, ShouldBeNil)
		So(hasFlag, ShouldEqual, false)
	})

	Convey("change has flag set", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nNOAUTOREVERT=true\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
					},
				},
			},
		}

		hasFlag, err := HasAutoRevertOffFlagSet(ctx, change)
		So(err, ShouldBeNil)
		So(hasFlag, ShouldEqual, true)
	})

	Convey("change has flag set with extra whitespace", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nNOAUTOREVERT\t=   true\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
					},
				},
			},
		}

		hasFlag, err := HasAutoRevertOffFlagSet(ctx, change)
		So(err, ShouldBeNil)
		So(hasFlag, ShouldEqual, true)
	})

	Convey("change has flag set to false", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nNOAUTOREVERT=false SOMEOTHERFLAG=true\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
					},
				},
			},
		}

		hasFlag, err := HasAutoRevertOffFlagSet(ctx, change)
		So(err, ShouldBeNil)
		So(hasFlag, ShouldEqual, false)
	})
}

func TestAuthorEmail(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	Convey("change does not have enough information", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  234567,
		}
		_, err := AuthorEmail(ctx, change)
		So(err, ShouldErrLike, "could not get", "info")
	})

	Convey("change does not have an author", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
					},
				},
			},
		}

		_, err := AuthorEmail(ctx, change)
		So(err, ShouldErrLike, "no author in commit info")
	})

	Convey("author email is returned", t, func() {
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: "Title.\n\nBody is here.\n\nNOAUTOREVERT=true\n\nChange-Id: I100deadbeef",
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
						Author: &gerritpb.GitPersonInfo{
							Name:  "John Doe",
							Email: "jdoe@example.com",
						},
					},
				},
			},
		}

		author, err := AuthorEmail(ctx, change)
		So(err, ShouldBeNil)
		So(author, ShouldEqual, "jdoe@example.com")
	})
}

func TestCommitMessage(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	Convey("change does not have enough information", t, func() {
		change := &gerritpb.ChangeInfo{
			Project: "chromium/test/src",
			Number:  234567,
		}
		_, err := CommitMessage(ctx, change)
		So(err, ShouldErrLike, "could not get", "info")
	})

	Convey("commit message is returned", t, func() {
		expectedMessage := "Title.\n\nBody is here.\n\nNOAUTOREVERT=true\n\nChange-Id: I100deadbeef"
		change := &gerritpb.ChangeInfo{
			Project:         "chromium/test/src",
			Number:          234567,
			CurrentRevision: "deadbeef",
			Revisions: map[string]*gerritpb.RevisionInfo{
				"deadbeef": {
					Number: 1,
					Kind:   gerritpb.RevisionInfo_REWORK,
					Uploader: &gerritpb.AccountInfo{
						AccountId:       1000096,
						Name:            "John Doe",
						Email:           "jdoe@example.com",
						SecondaryEmails: []string{"johndoe@chromium.org"},
						Username:        "jdoe",
					},
					Ref:         "refs/changes/123",
					Description: "first upload",
					Files: map[string]*gerritpb.FileInfo{
						"go/to/file.go": {
							LinesInserted: 32,
							LinesDeleted:  44,
							SizeDelta:     -567,
							Size:          11984,
						},
					},
					Commit: &gerritpb.CommitInfo{
						Id:      "",
						Message: expectedMessage,
						Parents: []*gerritpb.CommitInfo_Parent{
							{Id: "deadbeef00"},
						},
						Author: &gerritpb.GitPersonInfo{
							Name:  "John Doe",
							Email: "jdoe@example.com",
						},
					},
				},
			},
		}

		message, err := CommitMessage(ctx, change)
		So(err, ShouldBeNil)
		So(message, ShouldEqual, expectedMessage)
	})
}