buildbucket/appengine/model/project.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 model

import (
	"context"

	"go.chromium.org/luci/gae/service/datastore"

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

const (
	// ProjectKind is a project entity's kind in the datastore.
	ProjectKind = "Project"
)

// Project is the parent entity of buckets in the datastore.
// Entities of this kind may not exist in the datastore if they don't have
// global_config.
type Project struct {
	_kind string `gae:"$kind,Project"`
	ID    string `gae:"$id"`

	// CommonConfig is the share config among all buckets and builders in this
	// project.
	CommonConfig *pb.BuildbucketCfg_CommonConfig `gae:"common_config"`
}

// ProjectKey returns a datastore key of a project.
func ProjectKey(ctx context.Context, project string) *datastore.Key {
	return datastore.KeyForObj(ctx, &Project{ID: project})
}