go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/milo/rpc/query_builder_stats_test.go (about)

     1  // Copyright 2021 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package rpc
    16  
    17  import (
    18  	"context"
    19  	"fmt"
    20  	"testing"
    21  	"time"
    22  
    23  	. "github.com/smartystreets/goconvey/convey"
    24  	"go.chromium.org/luci/auth/identity"
    25  	"go.chromium.org/luci/buildbucket/bbperms"
    26  	buildbucketpb "go.chromium.org/luci/buildbucket/proto"
    27  	. "go.chromium.org/luci/common/testing/assertions"
    28  	"go.chromium.org/luci/gae/impl/memory"
    29  	"go.chromium.org/luci/gae/service/datastore"
    30  	"go.chromium.org/luci/milo/internal/model"
    31  	"go.chromium.org/luci/milo/internal/model/milostatus"
    32  	"go.chromium.org/luci/milo/internal/projectconfig"
    33  	"go.chromium.org/luci/milo/internal/testutils"
    34  	"go.chromium.org/luci/milo/internal/utils"
    35  	milopb "go.chromium.org/luci/milo/proto/v1"
    36  	"go.chromium.org/luci/server/auth"
    37  	"go.chromium.org/luci/server/auth/authtest"
    38  )
    39  
    40  func TestQueryBuilderStats(t *testing.T) {
    41  	t.Parallel()
    42  	Convey(`TestQueryBuilderStats`, t, func() {
    43  		ctx := memory.Use(context.Background())
    44  		ctx = testutils.SetUpTestGlobalCache(ctx)
    45  
    46  		datastore.GetTestable(ctx).AddIndexes(&datastore.IndexDefinition{
    47  			Kind: "BuildSummary",
    48  			SortBy: []datastore.IndexColumn{
    49  				{Property: "BuilderID"},
    50  				{Property: "Created", Descending: true},
    51  			},
    52  		})
    53  		datastore.GetTestable(ctx).Consistent(true)
    54  
    55  		srv := &MiloInternalService{}
    56  
    57  		builder1 := &buildbucketpb.BuilderID{
    58  			Project: "fake_project",
    59  			Bucket:  "fake_bucket",
    60  			Builder: "fake_builder1",
    61  		}
    62  		builder2 := &buildbucketpb.BuilderID{
    63  			Project: "fake_project",
    64  			Bucket:  "fake_bucket",
    65  			Builder: "fake_builder2",
    66  		}
    67  
    68  		createFakeBuild := func(builder *buildbucketpb.BuilderID, buildNum int, createdAt time.Time, status milostatus.Status) *model.BuildSummary {
    69  			builderID := utils.LegacyBuilderIDString(builder)
    70  			buildID := fmt.Sprintf("%s/%d", builderID, buildNum)
    71  			return &model.BuildSummary{
    72  				BuildKey:  datastore.MakeKey(ctx, "build", buildID),
    73  				ProjectID: builder.Project,
    74  				BuilderID: builderID,
    75  				BuildID:   buildID,
    76  				Summary: model.Summary{
    77  					Status: status,
    78  				},
    79  				Created: createdAt,
    80  			}
    81  		}
    82  
    83  		baseTime := time.Date(2020, 0, 0, 0, 0, 0, 0, time.UTC)
    84  		builds := []*model.BuildSummary{
    85  			createFakeBuild(builder1, 1, baseTime.AddDate(0, 0, -6), milostatus.Running),
    86  			createFakeBuild(builder1, 2, baseTime.AddDate(0, 0, -5), milostatus.Running),
    87  			createFakeBuild(builder1, 3, baseTime.AddDate(0, 0, -4), milostatus.Success),
    88  			createFakeBuild(builder2, 4, baseTime.AddDate(0, 0, -3), milostatus.Running),
    89  			createFakeBuild(builder1, 5, baseTime.AddDate(0, 0, -2), milostatus.Failure),
    90  			createFakeBuild(builder2, 6, baseTime.AddDate(0, 0, -3), milostatus.NotRun),
    91  			createFakeBuild(builder1, 7, baseTime.AddDate(0, 0, -1), milostatus.NotRun),
    92  		}
    93  
    94  		err := datastore.Put(ctx, builds)
    95  		So(err, ShouldBeNil)
    96  
    97  		err = datastore.Put(ctx, &projectconfig.Project{
    98  			ID:      "fake_project",
    99  			ACL:     projectconfig.ACL{Identities: []identity.Identity{"user"}},
   100  			LogoURL: "https://logo.com",
   101  		})
   102  		So(err, ShouldBeNil)
   103  
   104  		Convey(`get build stats`, func() {
   105  			ctx := auth.WithState(ctx, &authtest.FakeState{
   106  				Identity: "user",
   107  				IdentityPermissions: []authtest.RealmPermission{
   108  					{
   109  						Realm:      "fake_project:fake_bucket",
   110  						Permission: bbperms.BuildsList,
   111  					},
   112  				},
   113  			})
   114  
   115  			res, err := srv.QueryBuilderStats(ctx, &milopb.QueryBuilderStatsRequest{
   116  				Builder: builder1,
   117  			})
   118  			So(err, ShouldBeNil)
   119  			So(res.PendingBuildsCount, ShouldEqual, 1)
   120  			So(res.RunningBuildsCount, ShouldEqual, 2)
   121  		})
   122  
   123  		Convey(`reject users with no access`, func() {
   124  			ctx := auth.WithState(ctx, &authtest.FakeState{
   125  				Identity: "user",
   126  			})
   127  			_, err := srv.QueryBuilderStats(ctx, &milopb.QueryBuilderStatsRequest{
   128  				Builder: builder1,
   129  			})
   130  			So(err, ShouldNotBeNil)
   131  		})
   132  	})
   133  }
   134  
   135  func TestValidatesQueryBuilderStatsRequest(t *testing.T) {
   136  	t.Parallel()
   137  	Convey("validatesQueryBuilderStatsRequest", t, func() {
   138  		Convey("no builder", func() {
   139  			err := validatesQueryBuilderStatsRequest(&milopb.QueryBuilderStatsRequest{})
   140  			So(err, ShouldErrLike, "builder: project must match")
   141  		})
   142  
   143  		Convey("invalid builder", func() {
   144  			err := validatesQueryBuilderStatsRequest(&milopb.QueryBuilderStatsRequest{
   145  				Builder: &buildbucketpb.BuilderID{
   146  					Project: "fake_proj",
   147  					Bucket:  "fake[]ucket",
   148  					Builder: "fake_/uilder1",
   149  				},
   150  			})
   151  			So(err, ShouldErrLike, "builder: bucket must match")
   152  		})
   153  
   154  		Convey("valid", func() {
   155  			err := validatesQueryBuilderStatsRequest(&milopb.QueryBuilderStatsRequest{
   156  				Builder: &buildbucketpb.BuilderID{
   157  					Project: "fake_project",
   158  					Bucket:  "fake_bucket",
   159  					Builder: "fake_builder1",
   160  				},
   161  			})
   162  			So(err, ShouldBeNil)
   163  		})
   164  	})
   165  }